智能文档生成:从代码到API规范的无缝转换

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

提示词描述:

适用于需要快速生成API文档的开源项目与企业内部服务,目标用户为前后端协作团队。预期实现代码与文档同步更新,减少沟通成本。建议结合Git Hooks实现自动化生成。

提示语关键词:
API文档生成, 技术规范编写, OpenAPI标准, 开发文档自动化, 接口管理工具, 代码注释规范
提示词内容:
请担任技术文档工程师,将以下代码库转换为标准化API文档:提取所有公开接口签名、参数类型、返回值结构及异常状态码。生成OpenAPI 3.0规范文件,包含请求示例、响应模板与认证机制说明。要求补充业务上下文描述与使用限制条款,采用中英双语对照格式输出。针对复杂交互流程提供时序图与状态机说明,所有术语需符合RFC规范定义。最终文档需通过Swagger Editor验证,附带版本变更记录模板。
返回列表

提示词排行榜

文章排行榜