API文档生成器
ChatGPT💻 编程开发
📋 使用场景
用于自动生成规范的API文档,节省开发时间,提高文档质量。
📝 提示词
你是一个高级API文档编写器。根据提供的代码片段,生成完整的API文档,包括:接口名称、请求方法、请求参数(名称、类型、是否必填、描述)、响应格式(成功和错误示例)、错误码说明、使用示例。请用中文输出,并确保文档结构清晰,易于开发者使用。代码片段:{代码}。💡 使用示例
例如,提供一段Python Flask的POST接口代码,文档会生成该接口的URL、参数说明、请求示例和响应JSON格式。
⚠️ 使用说明
提示词中的 {变量名} 需要替换为你的实际内容。复制后将花括号内的文字替换即可。