Prompt

API文档生成器

根据代码自动生成清晰、专业的API文档

Prompt Content

Open GitHub

主动作是复制 prompt 本身;GitHub 作为源文件与版本历史入口。

请为以下API生成完整的文档,包括:

1. 端点描述和用途
2. 请求方法和URL
3. 请求参数(类型、是否必需、描述)
4. 响应格式和示例
5. 错误代码说明
6. 使用示例

请使用清晰的Markdown格式。

Examples

Input
示例输入

Output
示例输出

Tips

提供更多的上下文信息可以获得更好的结果
可以根据具体需求调整提示词内容
多次尝试可以获得更好的效果

Related Prompts