Skip to content

Endpoints HTTP

Todos os endpoints expostos pela aplicação de exemplo do NENE2. Cada resposta JSON segue os esquemas definidos em docs/openapi/openapi.yaml.

Saúde e diagnósticos

MétodoCaminhoAuthResposta
GET/healthNenhuma200 { service, status[, checks] } ou 503 se degradado
GET/examples/pingNenhuma200 { message }
GET/Nenhuma200 { name, description, status } resposta JSON

Notes (Notas)

MétodoCaminhoAuthSucessoErros
GET/examples/notesNenhuma200 lista422
POST/examples/notesNenhuma201 nota400, 413, 422
GET/examples/notes/{id}Nenhuma200 nota404, 413
PUT/examples/notes/{id}Nenhuma200 nota400, 404, 413, 422
DELETE/examples/notes/{id}Nenhuma204404

Tags (Etiquetas)

MétodoCaminhoAuthSucessoErros
GET/examples/tagsNenhuma200 lista422
POST/examples/tagsNenhuma201 tag400, 413, 422
GET/examples/tags/{id}Nenhuma200 tag404
PUT/examples/tags/{id}Nenhuma200 tag400, 404, 422
DELETE/examples/tags/{id}Nenhuma204404

Protegido (cliente máquina)

MétodoCaminhoAuthSucessoErros
GET/examples/protectedX-NENE2-API-Key ou Bearer200 JSON401

Erros seguem RFC 9457 Problem Details.

Publicado sob a licença MIT.