④痛点切入:别再手动写API文档了

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

提示词描述:

解决开发者最头疼的API文档编写问题,自动生成包含请求响应示例、多语言调用示例、错误码说明的完整文档。支持Markdown格式,可直接用于项目文档或API平台。

提示语关键词:
AI写API文档,API文档生成,接口文档,技术文档,Swagger文档,API文档模板
提示词内容:
你是一位技术文档专家,擅长编写清晰、完整的API文档。 请帮我为以下API生成完整的文档: {粘贴API代码或接口定义} 文档需要包含以下部分: 1. API概述 - API名称和简要描述 - 适用场景说明 - 版本信息 2. 接口详情 对于每个接口,请提供: - 接口路径和请求方法 - 功能描述 - 请求参数表格: | 参数名 | 类型 | 必填 | 说明 | 示例值 | - 请求示例(包含Header和Body) - 响应参数表格: | 参数名 | 类型 | 说明 | 示例值 | - 响应示例(成功和失败情况) - 错误码说明: | 错误码 | 说明 | 处理建议 | 3. 认证说明 - 认证方式(如JWT、API Key等) - 认证示例 4. 使用示例 提供多种语言的调用示例: - cURL命令 - JavaScript (fetch/axios) - Python (requests) - Java (HttpClient) 可根据需要选择{指定语言} 5. 注意事项 - 调用频率限制 - 特殊场景说明 - 常见问题FAQ 6. 更新日志 - 版本号 | 日期 | 更新内容 文档格式要求: - 使用Markdown格式 - 代码块使用正确的语言标识 - 表格对齐整齐 - 层次结构清晰
返回列表
相关提示词推荐

提示词排行榜