←

✨API接口文档撰写

办公提效文档处理文档整理规范命名

摘要说明

适用于“API接口文档撰写”场景的提示词模板。

提示词公式

接口名称 + 接口类型（GET/POST）+ 请求参数 + 响应参数 + 错误码说明 + 示例代码 + 注意事项 + 版本信息

完整提示词

ID 1755

撰写用户登录API接口文档，接口类型为POST，请求参数含username（字符串、必填）、password（字符串、必填、需MD5加密），...

核心关键词

参数清晰示例完整错误码详细版本明确

优化技巧

要求AI"示例代码需真实可用"（可直接复制运行），避免伪代码
明确"错误码需详细说明原因和解决方法"（如"1002密码错误→提示用户重试"），提升文档实用性
---