OpenAPI Design 是一个用于契约优先(contract-first)REST API 设计的技能,基于 OpenAPI 3.1 规范。
用途:在设计 REST API、定义 API 契约(Schema、路径、参数、响应)、以及应用 API 最佳实践(命名规范、状态码、版本管理)时使用。
主要能力:以 OpenAPI 3.1 为核心进行契约优先设计;涵盖 openapi、info、servers、tags、paths、components(schemas、securitySchemes、responses、parameters)等结构;提供 HTTP 方法(GET/POST/PUT/PATCH/DELETE 及幂等性)与常用状态码(200、201、204、400、401、404、422 等)的快速参考;支持设计工作流与校验工具(如 Spectral)。
使用方式:按“需求 → OpenAPI 规范 → 评审 → 生成 → 实现 → 测试”的流程迭代,先设计后实现,便于前后端并行开发、自动生成客户端/服务端/文档,并按 Schema 校验请求与响应。技能要求文档优先:先调用 docs-management 技能获取 API 设计模式,并通过 MCP 服务器(context7 获取最新规范)核对 OpenAPI 3.1 语法,所有指导均以 OpenAPI 3.1 规范为基础。
限制:具体安装命令、收费或价格、平台支持范围等资料暂未提供;本技能面向 OpenAPI 3.1,其他版本未在资料中说明。