Table of Contents | ||||
---|---|---|---|---|
|
Purpose*
Необхідно зазначити призначення методу, а також посилання на бізнес процеси, в яких він задіяний
Наприклад: This method allows to receive active person declarations issued by the current legal entity (based on access_token)
...
Specification*
...
id | API_Specification |
---|
...
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
...
Потрібно зазначити тип методу за ступенем доступності
Preconditions
Які передумови мають бути виконані системою/користувачем. Наприклад:
створений запис в MedicationRequest;
рецепт відпущений (COMPLETED)
Logic*
Потрібно по пунктах описати логіку методу API або додати діаграму
Global and configurable parameters
Потрібно вказати посилання на сторінки з описом глобальних та конфігураційних параметрів
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
Dictionaries
Потрібно вказати посилання на сторінки довідників, які використовує метод API
Request structure*
See on Apiary
Example:
...
title | Request example |
---|
...
Table of Contents | ||||
---|---|---|---|---|
|
Purpose
Returns information about the user whose ID is in the token.
Specification
Page Properties | |||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||||||||||||||||||
|
Input parameters
See onApiary
Filters
See onApiary
Dictionaries
GENDER
+DOCUMENT_TYPE
+ADDRESS_TYPE
COUNTRY
SETTLEMENT_TYPE
STREET_TYPE
PHONE_TYPE
+AUTHENTICATION_METHOD
+DOCUMENT_RELATIONSHIP_TYPE
Request structure
See onApiary
Authorize
Request to process the request using a token in the headers
Headers
Content-Type:application/json
Authorization:Bearer {{access_token}}
Request data validation
Response structure
See onApiary
Example:
Expand | ||
---|---|---|
| ||
|
Authorize*
Вимоги до авторизації: яким чином надається доступ до використання методу
Request to process the request using a token in the headers
Headers*
Наприклад:
Content-Type:application/json
Authorization:Bearer c2778f3064753ea70de870a53795f5c9
api-key:uXhEczJ56adsfh3Ri9SUkc4en
Request data validation*
Валідація даних
Наприклад:
Validate request using JSON schema
In case validation failed - generate 422 error
Processing*
Потрібно описати процеси, які відбуваються з даними
1. Using global parameters
Потрібно викликати глобальні параметри (Global parameters), щоб отримати наведені нижче параметри
Response structure*
See on Apiary
Example:
Expand | ||
---|---|---|
| ||
|
Post-processing processes*
...
HTTP status codes
...
Page Properties | |||||||||
---|---|---|---|---|---|---|---|---|---|
| |||||||||
|
Backward compatibility
...