| Table of Contents |
|---|
Document properties
...
Parameter
...
Value
...
Description
...
Document status
...
| Status | ||||
|---|---|---|---|---|
|
...
Поточний статус документу
...
Decision maker
...
Особа що приймає рішення
...
Decision
...
Прийняте рішення
Purpose
Specification
...
Parameter
...
Value
...
Description
...
Method ID
...
Унікальний ідентифікатор методу
...
Microservices
...
Перелік мікросервісів, які використовує метод API, наприклад: Auth, ABAC
...
Components
...
Зазначається перелік бізнес компонентів, які використовують цей метод, наприклад: ePrescription
...
Essence
...
Назва сутності до якої належить метод
...
Link
...
...
Посилання на Apiary або Swagger
...
Resource
...
Посилання на ресурс, наприклад: /api/persons/create
...
Scope
...
Scope для доступу
...
Protocol type
...
Тип протоколу, який використовується запитом, наприклад: SOAP | REST
...
Request type
...
Тип запиту API, наприклад: GET, POST, PATCH…
...
Sync/Async
...
Метод є синхронним чи асинхронним?
...
Public/Private/Internal
...
Потрібно зазначити тип методу за ступенем доступності
Logic
Request structure
| Expand | ||
|---|---|---|
| ||
|
Authorize
Headers
Request data validation
Processing
Response structure
Example:
| Expand | ||
|---|---|---|
| ||
|
| Expand | ||
|---|---|---|
| ||
|
Post-processing processes
HTTP status codes
...
Error code
...
HTTP status code
...
Message
...
Translation of the message
...
...
...
Recommended attribute translations
...
Attribute Name
...
Sub Attribute Name
...
Attribute Type
...
Переклад (рекомендований)
...
Реалізація МІС XX.XX обов'язкова
...
Заповнює користувач
...
Відтворення в UI
...
Метод API
...
Методи API
Technical modules where the method is used
| Page Properties Report |
|---|