中文精选提示词 · 一键复制 · 陪你用好 AI

✍ 搭子陪写
Vibe Coding提示词AI入门★ 搭子精选

API 接口文档自动生成器(注释转 Markdown)

把零散的接口代码或自然语言需求,整理成结构规范、可直接发布的 Markdown 接口文档,含请求参数、响应结构、错误码与调用示例。

★★★★★ 搭子评分 · 难度 入门 · 作者 提示词搭子(AI 生成) · 协议 CC-BY 4.0
人工精选 · 一键复制即用
适用场景:后端同学需要把新接口快速产出规范文档、或交接时代替手写说明时直接复制使用。
提示词内容
你是一名资深后端工程师与技术文档专家。现在我需要你把一个接口或一个功能模块,整理成一份结构清晰、可直接发布的 Markdown 接口文档。

请严格按照以下结构输出:

一、接口概览
用简短条目给出:接口名称与一句话用途、所属服务与版本号、请求方式(GET/POST/PUT/DELETE)与完整路径、是否需要鉴权、适用的调用场景。

二、请求参数
用表格列出每个字段,列名依次为:参数名、类型、是否必填、默认值、含义说明、示例值。如果参数存在嵌套结构(对象或数组),请单独展开子表,清楚标注层级与归属关系,不要遗漏任何子字段。

三、响应结构
先说明成功响应的整体形态(对象还是数组),再用表格列出顶层字段:字段名、类型、含义、示例。对返回的关键业务字段给出必要解释。最后约定分页规则、通用状态码、错误信息的统一返回格式。

四、错误码说明
用表格列出常见错误码:错误码、含义、触发原因、排查与解决建议。至少覆盖参数错误、未授权、资源不存在、限流、服务端异常五类。

五、调用示例
给出一个完整的请求示例(含请求头与请求体,使用代码块包裹)和一个典型的成功响应示例(同样用代码块)。示例必须真实可运行,不能写占位符或省略关键字段。

六、注意事项与边界条件
说明接口的幂等性、并发安全、超时时间、权限边界、数据一致性等需要调用方特别留意的点。

输出要求:
1. 字段命名必须与我的代码或需求严格一致,不要擅自改名或翻译。
2. 所有表格必须完整,缺失字段时请明确标注「暂无」。
3. 示例必须真实可读,便于直接复制测试。
4. 语言简洁专业,避免空话套话。

下面是我提供的接口信息(代码或需求描述),请据此生成完整文档:
[在此粘贴你的接口代码或需求描述]

来源:本站 AI 原生生成内容(原创,遵循 CC-BY 4.0,可自由使用并注明出处)。