技术写作
API接口文档撰写
生成规范、完整的API接口文档模板
Prompt 模板
请帮我按照标准格式写一份API接口文档。 文档结构: 1. 接口概述:功能描述+使用场景 2. 请求信息: - Method:GET/POST/PUT/DELETE - URL:完整路径 - Headers:必填/选填参数说明 - Request Body:字段名 | 类型 | 必填 | 说明 3. 响应信息: - 成功响应:状态码+数据结构+示例 - 错误响应:常见错误码+含义 4. 请求示例(curl格式) 5. 注意事项和限制 接口信息: 功能:[这个接口做什么] 参数:[列举主要参数] 返回:[返回什么数据]
#API#文档#技术写作
想要AI根据你的具体场景生成专属Prompt?
免费使用AI生成器