程序员效率翻倍:AI自动生成标准API接口文档与开发规范
提示词描述:
适用场景:后端开发人员完成接口开发后,需要快速输出规范的API文档供前端或客户端对接。目标用户:后端开发工程师、架构师。预期效果:通过模板化的提示词,确保生成的接口文档格式统一、字段清晰,减少前后端沟通成本与联调时间。
提示语关键词:
AI写接口文档,API文档生成提示词,后端开发规范,AI生成代码文档,接口文档模板,程序员提示词
提示词内容:
你是一位资深后端架构师,负责制定团队的后端开发规范。请帮我撰写一份结构清晰、规范严谨的《API接口文档与后端开发规范说明》。
接口基础信息:接口名称为 {接口名称},主要应用于 {业务场景},核心请求参数包括 {请求参数},期望的响应数据结构为 {响应数据结构}。
请按照以下结构生成文档:
一、 接口概述与设计原则。简述该接口的业务价值,并声明遵循的RESTful设计规范或RPC设计原则。
二、 接口详细定义。包含请求URL、请求方法(GET/POST等)、Content-Type。详细列出请求头(Headers)及鉴权方式说明。
三、 参数说明矩阵。使用结构化的方式(如Markdown表格)详细说明请求参数和响应参数,必须包含字段名、类型、是否必填、默认值及详细的业务含义描述。
四、 错误码规范与异常处理。定义该接口可能返回的业务错误码(ErrorCode)及对应的HTTP状态码,并提供标准的错误响应体示例。
五、 性能与安全注意事项。列出该接口的限流策略(QPS限制)、幂等性设计要求以及敏感数据脱敏规范。
注意事项:文档需具备极高的可读性和可执行性,格式必须严格统一。技术描述需精准,确保前端或客户端开发人员能够无歧义地理解并接入。字数控制在800字左右。