Table of Contents |
---|
...
Link | Посилання на Apiary або Swagger | |
Resource | /api/v2/employee_requests | Посилання на ресурс, наприклад: /api/persons/create |
Scope | employee_request:write | Scope для доступу |
Components | Employee Requests | Зазначається перелік бізнес компонентів, які використовують цей метод, наприклад: ePrescription |
Microservices | API paragraph not found | Перелік мікросервісів, які використовує метод API, наприклад: Auth, ABAC |
Protocol type | REST | Тип протоколу, який використовується запитом, наприклад: SOAP | REST |
Request type | POST | Тип запиту API, наприклад: GET, POST, PATCH… |
Sync/Async | Sync | Метод є синхронним чи асинхронним? |
Public/Private/Internal | Public | Потрібно зазначити тип методу за ступенем доступності |
Logic
...
Dictionaries
Потрібно вказати довідники, які використовує метод API
Request structure
See on Apiary
...