用途:在编写 OpenAPI/Swagger 规范时提供最佳实践参考,帮助组织可复用的模式、端点文档、错误响应与认证配置。
主要能力:
- 模式定义:在 components/schemas 中定义对象,包含 type、description、required、properties,以及 format 与 example 字段。
- 端点文档:在 paths 下描述接口,包含 summary、description、operationId、tags、parameters 和 responses。
- 错误响应:定义 Error 模式,包含 code 与 message 字段。
- 认证:通过 components/securitySchemes 定义 bearerAuth(type: http、scheme: bearer、bearerFormat: JWT),并在 security 中引用。
- 决策指引:需要可复用模式用 components/schemas;需要认证信息用 securitySchemes;需要示例用 example 字段;需要多格式用内容协商;需要错误响应用错误模式。
使用方式:按上述结构编写 openapi.yaml,然后可用命令校验与生成产物: npx @redocly/cli lint openapi.yaml npx @redocly/cli build-docs openapi.yaml npx openapi-generator-cli generate -i openapi.yaml -g typescript-axios -o ./client
适用场景:编写或维护 OpenAPI/Swagger 规范、需要统一模式与端点文档风格、需要生成文档或客户端代码时。
限制:资料未提供具体版本要求、完整规则清单、错误处理细节及平台支持范围,暂未提供。