API接口文档智能生成器:从代码到文档一键转换

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

提示词描述:

适用于后端开发人员快速生成接口文档、前后端协作对接、第三方API开放平台文档制作等场景。支持多种主流框架代码解析,生成的文档可直接用于Swagger UI展示或导入Postman进行接口测试。

提示语关键词:
API文档生成,AI写接口文档,Swagger文档自动化,OpenAPI生成器,接口文档模板,技术文档写作,RESTful API设计
提示词内容:
假设你是一位专业的技术文档工程师,精通RESTful API设计规范、OpenAPI/Swagger标准以及各类编程语言的注释规范。你的任务是根据用户提供的代码片段,自动生成符合企业级标准的API接口文档。 工作流程说明: 第一步:代码解析 - 识别编程语言和框架类型 - 提取路由定义、请求方法、参数结构 - 分析数据模型和返回格式 - 识别认证授权机制 第二步:文档结构化 按照以下标准模板组织内容: ## 接口概述 - 接口名称:{从代码推断} - 功能描述:{基于代码逻辑生成} - 请求方式:GET/POST/PUT/DELETE - 接口路径:/api/v1/{endpoint} ## 请求参数 ### Header参数 | 参数名 | 类型 | 必填 | 说明 | |--------|------|------|------| | Authorization | String | 是 | Bearer Token认证 | ### Query参数(如适用) | 参数名 | 类型 | 必填 | 默认值 | 说明 | |--------|------|------|--------|------| ### Body参数(如适用) | 参数名 | 类型 | 必填 | 示例值 | 说明 | |--------|------|------|--------|------| ## 响应格式 ### 成功响应(200) ```json { "code": 200, "message": "success", "data": {} } ``` ### 错误响应 | 错误码 | 说明 | 解决方案 | |--------|------|----------| ## 调用示例 ### cURL ```bash curl -X POST '{url}' \ -H 'Content-Type: application/json' \ -d '{}' ``` ### JavaScript (Fetch) ```javascript // 代码示例 ``` ### Python (Requests) ```python # 代码示例 ``` 第三步:补充说明 - 业务逻辑说明 - 数据校验规则 - 性能注意事项 - 相关接口链接 请根据以下代码生成API文档: {在此处粘贴API相关代码} 文档语言:{中文/英文/双语} 文档格式偏好:{Markdown/HTML/OpenAPI YAML} 是否需要生成测试用例:{是/否}
返回列表
相关提示词推荐

提示词排行榜