Child pages
  • Структура API

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Модули

 API модуля

Code Block
# Основа API модуля
Abills/modules/[module]/Api.pm

# Контроллеры API модуля
Abills/modules/[module]/Api/(admin|user)/[controller].pm

# Валидации
Abills/modules/[module]/Validations.pm

# Список ошибок
Abills/modules/[module]/Errors.pm

# Словарь ошибок
Abills/modules/[module]/lng_english.pm

Тесты Api

Code Block
# консольный тест
Abills/modules/[module]/t/Api.t

# схемы
Abills/modules/[module]/t/schemas/(admin|user)

# схемы для пути-метода
Abills/modules/[module]/t/schemas/(admin|user)/[path_method]/
  request.json - схема реквеста
  schema.json  - схема ответа

OpenAPI

Code Block
# Список путей
Abills/modules/[module name]/Api/swagger/(admin|user)/paths.yaml

# Описание для одного пути
Abills/modules/[module]/Api/swagger/(admin|user)/paths/[path].yaml

# Реквест, ответ схемы для одного метода-пути
Abills/modules/[module]/Api/swagger/(admin|user)/paths/[path_method].yaml

# Ответы для одного варианта пути
misc/api/(admin|user)/[sub/module]/paths/[method_path].yaml