Skip to content

HTTP 端点 ​

NENE2 示例应用公开的所有端点。 所有 JSON 响应均遵循 docs/openapi/openapi.yaml 中定义的模式。

健康检查与诊断 ​

方法路径认证响应
GET/health无200 { service, status[, checks] } 或降级时 503
GET/examples/ping无200 { message }
GET/无200 { name, description, status } JSON 响应

Notes(笔记) ​

方法路径认证成功错误
GET/examples/notes无200 列表422
POST/examples/notes无201 笔记400、413、422
GET/examples/notes/{id}无200 笔记404、413
PUT/examples/notes/{id}无200 笔记400、404、413、422
DELETE/examples/notes/{id}无204404

Tags(标签) ​

方法路径认证成功错误
GET/examples/tags无200 列表422
POST/examples/tags无201 标签400、413、422
GET/examples/tags/{id}无200 标签404
PUT/examples/tags/{id}无200 标签400、404、422
DELETE/examples/tags/{id}无204404

受保护端点(机器客户端) ​

方法路径认证成功错误
GET/examples/protectedX-NENE2-API-Key 或 Bearer200 JSON401

错误响应遵循 RFC 9457 Problem Details。

基于 MIT 许可证发布。