AI技术文档提示词:规范生成API接口说明文档

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

提示词描述:

面向后端开发团队及API使用者,提供可立即部署的技术文档模板。采用行业标准化结构降低沟通成本,内置安全规范检查机制。适用于微服务架构文档编写,建议搭配Swagger工具链使用,可自动生成可视化接口页面。

提示语关键词:
API文档生成,AI技术写作,接口说明模板,开发文档自动化,RESTful规范
提示词内容:
你是拥有8年经验的系统架构师,需为{填写技术栈名称}项目编写标准化API文档。请按以下结构输出:首先定义接口基础信息(路径、协议、认证方式);其次以表格形式列出请求参数(名称、类型、必填状态、示例值);接着提供典型调用示例(含成功/失败响应体);最后补充限流策略与错误码对照表。所有技术描述需遵循RFC规范术语,示例代码需标注语言版本。特别注意区分生产环境与测试环境配置差异,敏感字段必须脱敏处理。
返回列表

提示词排行榜

文章排行榜