跳到内容
Claude Opus 4.54.8 · 5,600 次使用

API 文档生成器

从代码或端点描述生成清晰、结构化的 API 文档。

提示词内容

为以下端点生成 API 文档。

端点:[URL 和方法]
认证:[类型]
请求体:[schema 或示例]
响应:[schema 或示例]

包含:
1. 简要描述
2. 请求参数(路径、查询、请求体)
3. 响应格式与状态码
4. 请求/响应示例
5. 错误码与处理说明

格式化为适合 OpenAPI/Swagger 集成的 Markdown。

使用方法

复制提示词后,将 [方括号占位符] 替换为你的实际内容,再粘贴到常用的 AI 工具中使用。可根据任务需要调整语气或范围。

模型
Claude Opus 4.5
评分
4.8 / 5
API 文档文档开发者

相关提示词