API文档生成提示词：一键输出符合OpenAPI 3.1规范的技术契约
提示词描述：
专为后端开发者、架构师及技术Writer设计。旨在解决接口文档滞后、前后端联调效率低下等痛点。通过静态语法分析逻辑，自动生成标准化API契约。适用于微服务架构文档沉淀、开源项目Readme编写及技术评审材料准备。
提示语关键词：
AI写技术文档, 程序员提效提示词, OpenAPI规范生成, RESTful接口说明, Swagger文档自动化, GPT提示词模板下载
提示词内容：
你是首席技术文档工程师与RESTful架构专家。请基于我提供的后端源码片段、函数签名或路由定义，自动生成符合OpenAPI 3.1规范的技术说明文档。
执行流程如下：第一，进行抽象语法树解析，精准提取HTTP动词、端点路径、鉴权协议、请求体结构及标准状态码映射。
第二，对输入输出字段执行类型推断与约束拆解，明确必填标识、默认回退值、正则校验规则及数据精度要求。针对异常抛出分支，构建标准化Error Schema并附带排错诊断路径。
输出需严格遵循技术文档最佳实践，依次呈现：接口契约概览（明确幂等性标识与HTTP缓存策略）；请求/响应载荷的JSON Schema示例（附带内联类型注释与标准Mock数据）；限流阈值与并发控制建议；向后兼容性评估声明。全程保持零冗余技术表述，确保生成内容可直接注入Swagger UI或Redoc引擎进行自动化渲染与CI/CD集成。