Purpose
API paragraph not found
Specification
| Page Properties |
|---|
|
Link | | Посилання на Apiary або Swagger | Resource | | Посилання на ресурс, наприклад: /api/persons/create | Scope | | Scope для доступу | Components | | Зазначається перелік бізнес компонентів, які використовують цей метод, наприклад: ePrescription | Microservices | | Перелік мікросервісів, які використовує метод API, наприклад: Auth, ABAC | Protocol type | | Тип протоколу, який використовується запитом, наприклад: SOAP | REST | Request type | | Тип запиту API, наприклад: GET, POST, PATCH… | Sync/Async | | Метод є синхронним чи асинхронним? | Public/Private/Internal | | Потрібно зазначити тип методу за ступенем доступності |
|
Logic
API paragraph not found
Input parameters
Input parameter | Values | Type | Description | Example |
|---|
| | | | |
| | | | |
| | | | |
Request structure
API paragraph not found
Authorize
Request to process the request using a token in the headers
...
Request data validation
API paragraph not found
Processing
API paragraph not found
Response structure
See on Apiary
...
Post-processing processes
API paragraph not found
HTTP status codes
| Page Properties |
|---|
|
HTTP status code | Message | What caused the error |
|---|
200 | | |
|
...