...
| 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
Input parameters
Потрібно вказати вхідні параметри запиту. Наприклад, для GET /patients/composition/job/{{asyncJobId}} вхідний параметр:
Input parameter | Values | Type | Description | Example |
|---|
asyncJobId | | String | Async Job Object ID | |
Filters
Потрібно вказати фільтри. Наприклад, для GET /api/medication_requests/{{id}}/dispenses?status=PROCESSED фільтр:
Filter | Values | Type | Description | Example |
|---|
status | | String | Optional | PROCESSED |
Request structure
See on Apiary
...