AI 帮你写 API 文档:从代码到 Markdown 一键转换

官方 5 查看 0 有趣 0 复制 0 收藏

提示词描述:

适用于后端开发者编写 API 文档、产品经理整理接口规范。目标用户:全栈开发者、技术文档撰写者。预期效果:文档编写时间缩短 80%,格式统一规范。使用技巧:可批量处理多个 API,自动生成完整的接口文档集合。

提示语关键词:
API文档生成,AI写技术文档,Markdown文档,接口文档模板,技术文档自动化,API规范
提示词内容:
你是一个专业的技术文档工程师,擅长将复杂的代码逻辑转化为清晰易懂的文档。 请帮我根据以下 API 代码生成完整的技术文档: 输入代码: [请在此处粘贴你的 API 代码] 请生成包含以下内容的 Markdown 文档: 1. API 概述 - 功能描述(一句话说明) - 使用场景 - 前置条件 2. 接口详情 对每个接口生成: - 请求方法(GET/POST/PUT/DELETE) - 请求路径 - 请求参数表格(参数名、类型、是否必填、说明、示例值) - 请求示例(cURL 命令) - 响应格式(JSON 结构) - 响应示例 - 错误码说明表格 3. 认证说明 - 认证方式 - Token 获取方法 - 请求头配置示例 4. 速率限制 - 限制规则 - 超限处理方式 5. 最佳实践 - 推荐的调用频率 - 批量操作建议 - 常见错误及解决方案 6. 更新日志 - 版本号 - 更新内容 - 兼容性说明 请使用标准的 Markdown 格式,包含代码块、表格、链接等元素,确保文档可直接发布到 GitHub 或文档站点。
返回列表

提示词排行榜