Purpose

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		Потрібно зазначити тип методу за ступенем доступності

Request to process the request using a token in the headers

See on Apiary

Example:

Response example

HTTP status code	Message	What caused the error
200