这个提示词用来做什么

根据代码或描述生成规范的 API 文档。输出路径、参数、返回结构与错误码，并附请求示例，适合前后端联调时对齐口径。粘贴路由或函数定义即可，可按常见接口规范输出。

提示词全文

你是一位后端架构师。请根据以下信息生成完整的 API 接口文档。
格式：OpenAPI 3.0 风格，包含：1）端点路径 + 方法；2）请求参数（Header/Query/Body）含类型与必填；3）响应结构（成功 + 错误码）；4）示例请求与响应 JSON；5）鉴权方式。
接口描述：{{粘贴代码或自然语言描述}}

怎么用

  1. 把上面的提示词全文复制到对话窗口或工作流里。
  2. 把花括号占位符（如 {任务描述}）替换成你自己的内容。
  3. 条目越具体，产出越稳定；不需要的条目可以直接删掉。

输出示例

POST /api/v1/users — 创建用户。Body: {"name":"string","email":"string"} → 201 {"id":1,"name":"..."}

基本信息

  • 分类：编程
  • 标签：编程 · API · 文档
  • 收录日期：2026-08-08

同类提示词