用途:面向 REST 与 GraphQL API 的设计与规划,覆盖资源建模、端点设计、契约文档与演进策略。主要能力:识别资源与关系,定义 URI 模式与 HTTP 方法、请求响应结构;编写 OpenAPI 3.1 规范;设计分页与过滤;统一错误响应;规划版本与弃用策略;梳理认证授权流程;提供请求响应示例。使用方式:按核心流程推进——分析领域需求与数据模型,建模资源与操作,设计端点,产出 OpenAPI 3.1 契约,再规划版本演进;可根据上下文加载 REST 模式、版本管理、分页、错误处理、OpenAPI 等参考文件。约束要求:遵循面向资源的 REST 原则,URI 不使用动词,命名保持一致,为集合端点实现分页,记录错误码与认证授权,版本需有清晰弃用政策,不得制造无迁移路径的破坏性变更,需考虑限流,避免泄露实现细节。适用场景:新建 REST 或 GraphQL API、编写 OpenAPI 规范、设计 API 架构与接口契约。限制:未提供具体安装或调用命令,收费、平台与效果信息暂未提供。
api-designer
编程与开发
更新于 10-16 06:14