API 概览

这里用于维护接口说明、认证方式、错误码和请求示例。

建议结构

• 认证：访问令牌、签名规则、权限范围。
• 资源：按业务模块组织接口。
• 错误码：统一错误响应和排查建议。
• 变更记录：接口版本更新和兼容性说明。

示例

GET /api/health HTTP/1.1
Host: example.com

{
  "status": "ok"
}