Ключи карты
Карта содержит HTTP-методы, внутри них — адреса роутов и массивы настроек.
Ключи модуля задаются константами из Native\Api\Config\Internals.
Настройки роута
| Константа | Значение |
|---|---|
| ControllerConfig::CONTROLLER | controller |
| RouteConfig::ACTIVE | active |
| RouteConfig::ROUTE_TYPE | type |
| RouteConfig::DESCRIPTION | description |
| RouteConfig::PARAMETERS | parameters |
| RouteConfig::SECURITY | security |
| RouteConfig::FORMAT | format |
| RouteConfig::CACHE | cache |
| RouteConfig::RESPONSE | response |
active по умолчанию равен true, формат ответа — json. В format можно выбрать JSON или XML. Контроллер задаётся как класс и метод, вызываемый класс или PHP-файл.
type необязателен. Значения native, provider, service связывают роут с настройкой активности соответствующей категории.
При active => false роут не включается в документацию. Проверка активности возвращает ROUTE_DISABLED (HTTP 403).
Вложенные ключи
| Блок | Ключи | Описание раздела |
|---|---|---|
| parameters[имя] | type, required, possibleValue, parameters | Параметры запроса |
| security | auth, token_type, group, ip | Безопасность |
| security.group | whitelist, blacklist | Доступ по группам |
| security.ip | whitelist, blacklist | Доступ по IP |
| cache | ttl | Ответ и кеш |
| response | technical_keys_disabled | Ответ и кеш |
Поля описания документации приведены в отдельном разделе.
response управляет ответом модуля, а responses описывает ответы в документации.
Пользовательские поля
Получение собственных полей:
$config = \Native\Api\Context::getCurrent()
->getRoute()
->getConfig()
->toArray();