Título
Use títulos curtos e claros que caibam em uma linha no sumário (ToC). Siga o padrão de verbos:| Método | Verbo | Exemplo |
|---|---|---|
POST | Criar | Criar uma conta |
GET | Listar | Listar contas |
GET (by ID) | Recuperar | Recuperar uma conta |
PATCH | Atualizar | Atualizar uma conta |
DELETE | Excluir / Desativar | Excluir uma conta |
Descrição
Comece com uma explicação clara e concisa do que o endpoint faz e quando usá-lo.Pré-requisitos
Liste o que é necessário para usar o endpoint (ex.: autenticação, permissões, entidades obrigatórias).Parâmetros
Inclua todos os parâmetros, agrupados por onde aparecem:
- Parâmetros de Header
- Parâmetros de Path
- Parâmetros de Query
Body (Payload)
Documente todos os campos que aparecem no corpo da requisição.| Campo | Tipo | Obrigatório | Descrição | Valores Possíveis | Padrão | Restrições | Exemplo |
|---|---|---|---|---|---|---|---|
name | string | Sim | Nome da conta | — | — | MaxLength: 100 | "Main Account" |
type | string | Sim | Tipo da conta | asset, liability | — | — | "asset" |
assetId | string | Sim | ID do ativo associado | — | — | UUID | "01fbc1..." |
Respostas de sucesso
Descreva o que os usuários recebem quando a requisição é bem-sucedida. Inclua códigos de status como200, 201 ou 204.

