用途:在需要设计 REST 或 GraphQL API、编写 OpenAPI 规范或规划 API 架构时使用,可辅助资源建模、版本策略与 API 演进规划。
主要能力:按“分析领域—建模资源—设计端点(URI、HTTP 方法、请求响应模式)—编写 OpenAPI 3.1 契约—模拟验证—规划版本与弃用”的工作流推进;可加载 REST 模式、版本化、分页、错误处理、OpenAPI 等专题参考。
必要用法与约束:设计须遵循 REST 原则,命名风格(snake_case 或 camelCase)统一,提供完整 OpenAPI 3.1 规范、可操作的错误响应(RFC 7807)、集合端点分页、清晰弃用策略,并记录认证授权与请求响应示例。不得在 URI 中使用动词(用 /users/{id} 而非 /getUser/{id}),不得出现不一致响应结构、忽略 HTTP 状态码语义、缺少版本策略或迁移路径,也不应遗漏限流考虑。
校验与模拟命令(保持原样):npx @redocly/cli lint openapi.yaml;npx @stoplight/prism-cli mock openapi.yaml。
适用场景:新 API 设计、API 契约评审、OpenAPI 文档与代码生成准备、版本迁移与弃用规划。
限制:资料未提供具体价格、平台支持范围、性能指标与实际使用效果,暂未提供。