AEX Engineering
TemplatesProject

API — {{NOMEDOPROJETO}}

{{AUTENTICACAO}}

1 min de leitura
Template pronto para copiar ou baixar

Visão geral

  • Base URL: {{BASE_URL}}
  • Formato: JSON
  • Versionamento: {{VERSIONAMENTO}}

Autenticação

{{AUTENTICACAO}}

Authorization: Bearer {{TOKEN}}

Convenções

  • Métodos HTTP conforme a semântica (GET, POST, PUT, PATCH, DELETE).
  • Respostas em JSON; datas em ISO 8601 (UTC).
  • {{CONVENCAO_EXTRA}}

Endpoints

{{METODO}} {{ROTA}}

{{DESCRICAO_ENDPOINT}}

Parâmetros

NomeLocalTipoObrigatórioDescrição
{{PARAM}}{{LOCAL}} {{TIPO}}{{SIM_NAO}}{{DESCRICAO}}

Request

{{EXEMPLO_REQUEST}}

Response — 200

{{EXEMPLO_RESPONSE}}

Erros

Formato padrão de erro:

{
  "error": {
    "code": "{{CODIGO_ERRO}}",
    "message": "{{MENSAGEM}}"
  }
}
Código HTTPSignificadoQuando ocorre
400Bad RequestDados inválidos na requisição.
401UnauthorizedAutenticação ausente ou inválida.
403ForbiddenSem permissão para o recurso.
404Not FoundRecurso não encontrado.
500Internal Server ErrorErro inesperado no servidor.

Arquitetura: ARCHITECTURE.md · Modelo de dados: DATABASE.md

Edit on GitHub

{{TITULODATAREFA}}

{{OBJETIVO}}

ARCHITECTURE — {{NOMEDOPROJETO}}

{{VISAOARQUITETURA}}

On this page

Visão geralAutenticaçãoConvençõesEndpoints{{METODO}} {{ROTA}}Erros