背景
后端已有 OpenAPI 规范(backend/internal/handler/openapi.yaml),运行时通过 /docs 提供 Swagger UI。但缺少一个独立的、可交互的 API 文档站,让开发者不用启动服务就能浏览所有 API。
目标
- 评估用 Scalar 或增强现有 Swagger UI
- 让 API 文档支持在线试调用(输入参数 → 发请求 → 看响应)
- 补充关键 API 的描述说明(目前部分端点 description 为空)
接入点
- OpenAPI 源:
backend/internal/handler/openapi.yaml
- 前端类型由此生成:
npm run gen-api-types
验证
文档站能正确展示全部 API,至少 login / customers / trade-rules 几组端点可在线试调。
适合想了解 OpenAPI / 前后端契约的开发者。
背景
后端已有 OpenAPI 规范(
backend/internal/handler/openapi.yaml),运行时通过/docs提供 Swagger UI。但缺少一个独立的、可交互的 API 文档站,让开发者不用启动服务就能浏览所有 API。目标
接入点
backend/internal/handler/openapi.yamlnpm run gen-api-types验证
文档站能正确展示全部 API,至少 login / customers / trade-rules 几组端点可在线试调。
适合想了解 OpenAPI / 前后端契约的开发者。