教程 api-development tutorial

OpenAPI / Swagger

OpenAPI 用机器可读格式描述 API,Swagger 常用于文档和调试界面。

核心要点

  • 先定义资源、请求方法、状态码和错误格式。
  • 给接口准备可复制的 curl 示例。
  • 把认证、分页、限流和版本策略写进文档。

最小实践

bash
npm install && npm run build

相关内容