castopod/modules/Api/Rest/V1/Config/RestApi.php

37 lines
779 B
PHP

<?php
declare(strict_types=1);
namespace Modules\Api\Rest\V1\Config;
use CodeIgniter\Config\BaseConfig;
class RestApi extends BaseConfig
{
/**
* Flag to enable or disable the Rest API.
*
* Disabled by default.
*/
public bool $enabled = false;
public bool $basicAuth = false;
public ?string $basicAuthUsername = null;
public ?string $basicAuthPassword = null;
/**
* Default results limit.
*/
public int $limit = 10;
/**
* --------------------------------------------------------------------------
* Rest API gateway
* --------------------------------------------------------------------------
* Defines a base route for all API pages
*/
public string $gateway = 'api/rest/v1/';
}