tariffs/docs/swagger/README.md
2023-03-17 17:42:31 +00:00

1.4 KiB
Raw Blame History

Swagger:

При запуске сервиса, документацию можно будет изучить по отдельной ссылке, которая выдаётся сервисом

Ссылка на Swagger документацию: <hostname>/swagger

Архитектура Swagger документации (Для разработчиков):

├── privilege
│   ├── index.ts
│   ├── inputs.ts
│   ├── models.ts
│   ├── responses.ts
├── tariff
│   ├── index.ts
│   ├── inputs.ts
│   ├── models.ts
│   ├── responses.ts
├── role
│   ├── index.ts
│   ├── inputs.ts
│   ├── models.ts
│   ├── responses.ts
├── account
│   ├── index.ts
│   ├── inputs.ts
│   ├── models.ts
│   ├── responses.ts
  • Каждая из директорий является названием группы обработчиков (routes)

  • index выдаёт все схемы для генерации документации

  • inputs содержит в себе все входные данные, требуемые обработчику: params, querystring, body

  • models хранит в себе все бизнес модели: user, tariff, role