用自然语言描述需求,让AI直接生成完整API文档——Apifox MCP Server实践

用 AI 管理 API 文档:Apifox MCP Server

项目背景

作为一名 Go 开发者,我的日常工作主要是开发 Web API 服务。Go 生态中有多种生成 API 文档的方案:

  • Swagger 注解配合 go-swagger 生成 OpenAPI 2.0 文档
  • huma + chi 组合生成 OpenAPI 3.0 文档
  • 契约优先的 oapi-codegen 工具
  • 让 AI 编写多个 YAML 文件,再用工具合并成完整文档

我曾尝试让 AI 直接生成 Swagger 注解,但效果并不理想:

  • 格式错误导致编译失败
  • 字段描述缺失
  • 错误响应定义不完整
  • 反复修改,效率还不如手写

我真正想要的是:用自然语言描述需求,让 AI 直接生成完整的 API 文档,而不是在代码里堆砌大量注释。

比如,项目开发完成后,AI 可以根据后端实现自动生成文档,MCP 服务还能检查是否存在重复定义、响应体示例是否完整等问题。

基于这个想法,我开发了这个项目——让 AI 直接操作 Apifox 来管理 OpenAPI 文档。希望对有类似需求的开发者有所帮助。

GitHub – iwen-conf/apifox-mcp at v1.0.0

v1.0.0

发表评论