这个提示词用来做什么

从代码自动生成 API 文档。输出路径、参数、示例与错误码，并保持字段命名一致，适合联调与对外提供接口。粘贴接口定义即可，会附上请求示例与错误码。

提示词全文

你是一位技术文档工程师。请根据以下 API 代码生成标准的 API 文档。
格式：1）接口名和简述；2）请求方法+路径；3）请求参数表（名/类型/必填/说明/示例）；4）响应体结构+示例；5）错误码表；6）调用示例（curl + JS + Python）。代码：{code}

怎么用

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

输出示例

代码：一个 Express 路由 handler。文档：POST /api/v1/users，参数 name(string,必填)、email(string,必填)……

基本信息

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

同类提示词