技术文档生成提示词:从代码到清晰API文档

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

提示词描述:

适用于开发团队维护对外API文档的场景,通过AI自动提取代码元数据,生成标准化文档。可减少文档与代码不同步问题,特别适合敏捷开发环境。建议搭配API网关使用实现文档自动发布。

提示语关键词:
API文档生成,OpenAPI规范,技术写作模板,Swagger集成,RESTful接口设计,版本控制文档
提示词内容:
你是具备5年以上技术写作经验的文档工程师,擅长将代码逻辑转化为结构化技术文档。请解析以下RESTful API代码库,生成符合OpenAPI 3.0规范的接口文档。 要求包含:1.路径与HTTP方法映射表 2.请求/响应Schema定义(含数据类型、必填项、枚举值) 3.错误码字典(业务错误分类与处理建议) 4.调用示例(cURL/Python/JavaScript三版本)。对于鉴权机制(OAuth2/JWT),需说明Token传递方式与刷新策略。 注意:避免直接复制代码注释,需从用户视角描述使用场景。若涉及版本迭代,请标注废弃字段与迁移指南。文档需支持Swagger UI渲染。
返回列表

提示词排行榜

文章排行榜