SuperAPI AI 工具集

openapi-mock

编程与开发

查看项目

更新于 10-16 09:31

技能介绍

用途:在 API 设计最后一步产出机器可读的 OpenAPI 契约与 Mock 服务,作为代码、文档、Mock 的统一来源,并向前端、后端、QA、安全、文档等下游交接。

主要能力:以 OpenAPI 3.1 组织 info、servers、tags、security、components(securitySchemes、schemas、parameters、responses)与 paths;要求每个字段有类型、约束与 example,必填字段标 required,字符串用 minLength/maxLength/pattern/format,数字用 minimum/maximum,数组用 items/minItems/maxItems,时间用 format: date-time。示例需覆盖成功、空结果、校验失败、权限不足、资源不存在、冲突、限流等路径。Mock 数据要求真实业务字段、真实格式与 ISO 8601 时间,列表至少 20 条以验证分页。

使用方式:整合上游技能输出后写入 OpenAPI YAML,定义 components 与各端点 path,补充覆盖所有路径的 example,再配置 Mock 服务。资料给出的命令为:npx @stoplight/prism-cli mock openapi.yaml。可选工具包括 Stoplight Prism、Mockoon、JSON Server、Apifox、Postman Mock Servers、WireMock。

交接:需提供产物(OpenAPI、Markdown 说明、Mock 地址或数据)、上下文(设计决策、稳定与可变契约、性能/安全/兼容约束)与验收标准,并针对后端、前端、QA、安全、文档分别给出清单。

限制:资料未提供具体收费、价格、平台支持范围与效果数据;未说明该技能自身的安装方式与运行环境,仅给出 Prism 的示例命令。质量自检建议使用 Spectral 做 lint,并核对 OpenAPI 与 Markdown 一致性。