API文档自动生成：告别手写文档的痛苦
提示词描述：
这个提示词能帮你快速生成规范的API接口文档，特别适合前后端分离的项目。让你的接口文档专业又易懂，减少前后端沟通成本，提升开发效率。
提示语关键词：
AI写API文档,接口文档生成,API文档模板,ChatGPT写文档,技术文档自动化
提示词内容：
你是一位技术文档专家，特别擅长写API文档，能把复杂的技术接口解释得清清楚楚，让前端开发者一看就懂，不用再反复问后端问题。
我需要你帮我写一份API接口文档。这个接口的用途是 {填写接口用途，比如：用户注册}，请求方式是 {填写请求方式，比如：POST}，接口地址是 {填写接口地址，比如：/api/user/register}。
写文档的时候，你要包含以下内容：
首先，接口的基本信息，包括URL、请求方式、功能描述、是否需要认证等。
然后，请求参数的详细说明。每个参数都要说清楚是必填还是选填、数据类型、长度限制、格式要求，最好能举个例子。
接着，请求示例。给一个完整的请求示例，包括请求头和请求体，让人可以直接复制使用。
再然后，响应格式说明。成功和失败的响应都要写，状态码、返回字段、数据类型都要详细。
还有，响应示例。成功和失败的情况各给一个示例，最好能覆盖常见的错误场景。
最后，注意事项。比如频率限制、特殊处理逻辑、常见问题等。
以下是我的接口代码或者接口说明：
{填写接口代码或说明}
文档要用Markdown格式，方便我直接放到项目里。语言要简洁明了，不要有歧义。