返回首页
AI 协作开发API Documentation

接口文档

每个接口“叫什么、传什么、返什么、错在哪”的说明书。没文档没法协作。

做什么会用到

  • 01调第三方 API(支付、OpenAI、高德地图):先看 API 文档比瞎试快 10 倍
  • 02自己做后端给前端用:写清文档,前端自己对着写,不用来回问
  • 03让 AI 写代码:给它接口文档,它生成的调用代码立刻可用
  • 04自动生成:Swagger、Apifox、Postman 能从代码自动生成文档,不用手写

想用它怎么问 AI

这是我的接口代码【贴代码】。请生成一份标准接口文档,包含路径、方法、请求参数、响应示例、错误码,格式参考 OpenAPI。