90 lines
1.8 KiB
Markdown
90 lines
1.8 KiB
Markdown
# Template: api_method
|
|
|
|
```md
|
|
---
|
|
id: api-<stable-id>
|
|
title: <Human-readable title>
|
|
doc_type: api_method
|
|
status: draft
|
|
source_of_truth: code
|
|
domain: <domain-name>
|
|
owner: system-analyst
|
|
endpoint: <METHOD /path>
|
|
auth: <auth-mode-or-unknown>
|
|
idempotent: <true-or-false>
|
|
related_docs:
|
|
- <doc-id>
|
|
related_code:
|
|
- <path/to/file>
|
|
entities:
|
|
- <EntityName>
|
|
tags:
|
|
- api
|
|
---
|
|
|
|
# <API Method Title>
|
|
|
|
## Purpose
|
|
|
|
Кратко опиши, какую системную задачу решает метод.
|
|
|
|
## Endpoint Summary
|
|
|
|
- Endpoint: `<METHOD /path>`
|
|
- Auth: `<auth-mode>`
|
|
- Idempotent: `<true/false>`
|
|
- Triggered by: `<ui/system/integration if known>`
|
|
|
|
## Technical Use Case
|
|
|
|
Опиши пошагово обработку запроса:
|
|
|
|
- вход в endpoint;
|
|
- ключевые проверки;
|
|
- вызовы логики;
|
|
- обращения к БД и внешним системам;
|
|
- формирование ответа.
|
|
|
|
## Functional Requirements
|
|
|
|
Вынеси сюда подтвержденные правила, которые дополняют основной сценарий:
|
|
|
|
- валидации;
|
|
- branching logic;
|
|
- побочные эффекты;
|
|
- ограничения по данным;
|
|
- условия ошибок.
|
|
|
|
## Request and Response Contract
|
|
|
|
Опиши контракт в кратком виде или дай ссылку на OpenAPI / контрактный файл.
|
|
|
|
## Related Logic Blocks
|
|
|
|
- [<Logic block title>](<path-or-doc-link>)
|
|
|
|
## Data Access and Integrations
|
|
|
|
- Reads DB: `<if known>`
|
|
- Writes DB: `<if known>`
|
|
- Integrates with: `<if known>`
|
|
|
|
## Non-Functional Requirements
|
|
|
|
Укажи только подтвержденные НФТ:
|
|
|
|
- timeout;
|
|
- audit;
|
|
- monitoring;
|
|
- security;
|
|
- idempotency rules.
|
|
|
|
## Related Code
|
|
|
|
- `<path/to/file>`
|
|
|
|
## Related Documents
|
|
|
|
- [<Related document>](<path-or-doc-link>)
|
|
```
|