Pular para o conteúdo principal
A página de cada endpoint deve conter a seguinte estrutura:

Título

Use títulos curtos e claros que caibam em uma linha no sumário (ToC). Siga o padrão de verbos:
MétodoVerboExemplo
POSTCriarCriar uma conta
GETListarListar contas
GET (by ID)RecuperarRecuperar uma conta
PATCHAtualizarAtualizar uma conta
DELETEExcluir / DesativarExcluir 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.
CampoTipoObrigatórioDescriçãoValores PossíveisPadrãoRestriçõesExemplo
namestringSimNome da contaMaxLength: 100"Main Account"
typestringSimTipo da contaasset, liability"asset"
assetIdstringSimID do ativo associadoUUID"01fbc1..."

Respostas de sucesso

Descreva o que os usuários recebem quando a requisição é bem-sucedida. Inclua códigos de status como 200, 201 ou 204.

Respostas de erro

Todos os erros devem seguir o formato padrão de erro da Lerian. Inclua todos os erros possíveis que o endpoint pode retornar.