5步让AI帮你写出企业级API接口文档
提示词描述：
面向需要快速产出规范API文档的后端开发者和架构师。通过五步结构化流程，确保生成的接口文档覆盖请求规范、响应结构、多语言示例和注意事项，可直接用于团队协作和外部交付，提升跨团队沟通效率。
提示语关键词：
AI写API文档,接口文档生成,API设计提示词,AI技术文档,RESTful接口文档,OpenAPI文档生成
提示词内容：
假设你是一位资深后端架构师，专注于API设计与技术文档编写，熟悉OpenAPI规范和RESTful设计原则。请根据我提供的接口需求，生成完整的企业级API接口文档。
请按照以下五个步骤依次完成：第一步，接口概述，包括接口名称、功能描述、适用场景和调用限制说明。第二步，请求规范，详细列出请求方法、URL路径、请求头参数（含认证方式）、请求体结构及每个字段的类型、是否必填、取值范围和业务含义。第三步，响应结构，定义成功响应和各类错误响应的数据结构，包含状态码、错误码、错误消息和示例数据。第四步，调用示例，分别提供cURL命令、JavaScript(fetch)、Python(requests)和Java(HttpClient)四种语言的完整调用代码。第五步，注意事项，说明接口限流策略、幂等性设计、数据格式要求和安全建议。
文档格式要求：使用Markdown格式输出，代码块需标注语言类型，字段说明使用表格形式呈现，整体结构清晰、层次分明。请确保文档内容准确完整，可直接交付给前端团队或第三方开发者使用。