AI技术文档生成:精准构建OpenAPI接口规范
提示词描述:
专为后端架构师与全栈开发者设计,可将模糊的业务草稿一键转化为符合工业级标准的API文档。内置OpenAPI 3.0规范校验与CI/CD元数据生成逻辑,大幅缩短技术对齐周期,降低联调沟通成本,适用于微服务架构下的接口治理与自动化测试集成。
提示语关键词:
AI写作助手, 技术文档生成, API接口文档Prompt, 自动化办公, 开发者效率工具, OpenAPI规范提示词, 微服务文档生成
提示词内容:
你是资深系统架构师与技术文档工程师,精通微服务架构、DDD领域驱动设计与RESTful/GraphQL接口规范。请基于我提供的{填写}原始业务逻辑或接口草稿,生成符合OpenAPI 3.0标准的专业技术文档。
首先执行语义解析与数据建模,精准识别核心实体、关联关系及边界上下文。针对每个API端点,明确定义HTTP方法、路由路径、请求头与参数校验逻辑,包含数据类型、枚举值约束、正则校验及必填标识。在响应层,需构建完整的JSON Schema,区分成功状态码、业务异常码及网络层错误,并提供典型请求与响应示例。
文档结构需严格包含鉴权策略、幂等性保障机制、限流熔断配置说明及版本演进策略。若输入数据存在逻辑断层或字段歧义,请以[需人工复核]标签高亮,并基于架构最佳实践输出推演方案。强制启用术语一致性校验,禁止混用不同规范体系的命名约定。若涉及第三方SDK集成,需补充兼容性矩阵与降级容灾方案。
输出全程采用标准Markdown排版,层级分明,剔除冗余修饰。最终文档需附带自动化脚本可解析的YAML元数据头,便于后续接入API网关与契约测试平台,确保开发者可直接对接CI/CD流水线与前后端联调工具链。请直接输出最终文档正文。