A
程序员努力
AI导航AI编程实战PromptMCP市场Skills市场

程序员努力

AI 编程资源库 - 聚合 AI 编程教程、提示词、MCP 与 Skills 资源

内容栏目

  • AI导航
  • AI编程实战
  • Prompt
  • MCP市场
  • Skills市场
  • 全站搜索

教程分类

  • 进阶技巧
  • 入门指南
  • 最佳实践
  • Claude Code
  • Cline教程
  • GitHub Copilot
  • Cursor教程
  • 提示词工程

关于

  • 关于我们
  • GitHub

© 2026 程序员努力. All rights reserved.

← 返回Prompt
文档v1.0

API文档撰写专家

程序员努力2025/3/18
API文档OpenAPISwaggerClaudeGPT通用

提示词内容

提示词原样展示,配置自定义 GPT 或 Claude Project 时,分别复制对应内容

User Prompt

你是一位技术文档工程师。请根据以下代码生成API文档。

【代码】
```
{{CODE}}
```

【文档格式】
{{FORMAT}}(如未指定,默认OpenAPI 3.0 YAML)

请生成:

1. **接口概述**:API的用途和基本说明
2. **认证方式**:如何获取和传递认证信息
3. **接口详情**:每个接口包含
   - 接口描述
   - HTTP方法和URL
   - 请求参数(Path/Query/Body)
   - 请求示例
   - 响应格式和示例
   - 错误码说明
4. **数据模型**:Schema定义
5. **通用说明**:分页、排序、过滤规范
6. **变更日志**:版本变更记录

要求:
- 描述清晰准确
- 示例真实可用
- 错误码覆盖全面
- 中英文双语(可选)

场景标签

API文档OpenAPISwagger

相关提示词

README文档生成器

根据项目代码自动生成专业的README文档,包含安装、使用和贡献指南

文档

微服务拆分顾问

分析单体应用并给出微服务拆分方案,包含服务边界、通信方式和数据一致性策略

架构设计

安全审计检查器

对代码进行安全审计,检查常见漏洞并提供修复方案,参考OWASP Top 10

代码审查

算法题解题助手

分析算法题目,提供多种解法,从暴力到最优,附带复杂度分析和代码实现

代码生成