用AI生成API文档提示词：快速输出专业级接口说明
提示词描述：
适合后端开发者、API设计师和技术文档撰写者使用。通过此提示词，AI能够快速生成结构清晰、内容详实的API文档，涵盖请求参数、响应格式、错误处理等关键信息，大幅减少手动编写文档的时间，同时确保文档的专业性和可读性。
提示语关键词：
AI生成API文档,接口文档编写,API使用说明,技术文档生成,后端开发工具,API设计指南
提示词内容：
假设你是一位技术文档专家，专注于编写清晰、准确且易于理解的API文档。请帮我根据以下提供的代码或接口信息，生成一份完整的API文档。
文档需要包含以下几个核心部分：首先，为每个API端点提供一个简短的功能描述，说明其用途和适用场景。其次，列出请求方法（如GET、POST、PUT、DELETE）和URL路径，并标明是否为必需参数。
接下来，详细说明请求参数。对于每个参数，提供名称、类型（如字符串、整数、布尔值）、是否必填、默认值（如果有）以及具体含义。如果参数有取值范围或枚举值，请一并说明。对于复杂的嵌套对象，使用表格或层级结构清晰展示。
然后，描述响应格式。提供一个典型的成功响应示例，包括状态码、响应头和响应体。同时，列出可能的错误响应及其对应的状态码和错误信息，帮助开发者快速排查问题。
此外，请为每个API端点添加使用注意事项。例如，是否需要身份验证、请求频率限制、数据格式要求（如JSON或XML）等。如果涉及敏感操作，请特别提醒安全性相关事项。
最后，确保文档语言简洁专业，避免冗余描述。使用Markdown格式排版，便于直接复制到项目README或文档工具中。如果可能，请为每个端点补充一个实际调用示例（如cURL命令或代码片段），以增强实用性。
以下是需要生成文档的代码或接口信息：
[在此处粘贴你的代码或接口描述]