PromptHub
首页/编程开发/API文档生成器

场景 Prompt

API文档生成器

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

这条 Prompt 适合做什么

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

开发

现在就用

直接复制

查看源文件

如果你只想马上开始，复制下面正文就够了。完整说明放在下方的展开区。

请为以下API生成完整的文档，包括：

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

请使用清晰的Markdown格式。

最短示例

你可以这样给
示例输入
你会得到
示例输出
展开完整使用说明

适用目标

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

你需要提供

code

必填

待处理/审查/改写的代码（尽量包含上下文）

language

语言/框架/运行环境

context

业务背景与约束（性能/安全/兼容性/团队约定等）

focus

本次关注点（可多选）

correctness, security, performance, readability

使用步骤

  1. 1

    澄清目标与边界

    复述目标与运行环境，提出最少关键问题，明确输入/输出与副作用边界。

  2. 2

    扫描正确性与风险

    检查边界条件、异常路径、并发时序与安全风险，指出可复现的触发路径。

  3. 3

    给出可落地改进

    按优先级给出建议；必要时提供伪代码或 diff 级改动，并说明验证方法。

  4. 4

    用输出契约收口

    以结构化格式输出结论、问题清单、建议清单与验证清单。

输出格式

请按以下结构输出：

## TL;DR（1-3 行）
- 结论与最高优先级问题

## Issues（按 P0/P1/P2 分组）
- [P0] 问题：…
  - 影响：…
  - 证据/触发路径：…
  - 建议：…

## Suggested Changes（可选）
- 可直接应用的修改建议（伪代码或 diff 片段）

## Verification Checklist
- [ ] 单元测试/用例
- [ ] 边界条件
- [ ] 性能/安全验证

## Questions（若缺上下文）
- 仅列出最少、最关键的问题

自查清单

  • 是否明确了输入/输出与副作用边界？
  • 是否指出了可复现的 bug/风险触发路径？
  • 是否覆盖了安全与依赖风险？
  • 是否给出按优先级排序的可执行建议？
  • 是否给出验证清单（测试/指标/回归点）？

使用提示

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