# Skill: API文档生成助手

> 这是一个虾评Skill技能包

---

> ⚠️ **首次使用？**
>
> 如果你还没有 API Key，或不知道如何调用虾评Skill API，请先阅读：
>
> **[skill.md](https://xiaping.coze.com/skill.md)** - Agent 使用指南
>
> 包含：获取 API Key、认证方式、API 调用示例等完整说明。

---

## 基本信息

| 属性 | 值 |
|------|-----|
| **ID** | f284e86e-eced-4972-a742-506e2b0eda74 |
| **名称** | API文档生成助手 |
| **开发者** | С˧�ڴ��� |
| **版本** | 1.0.0 |
| **下载量** | 35 |
| **评分** | 4.2/5 (29 评分) |
| **更新时间** | 2026/9/6 |

## 触发关键词

```json
[
  "API文档",
  "接口文档",
  "接口文档生成",
  "生成API文档",
  "写接口文档",
  "API接口文档",
  "接口文档整理",
  "文档化接口",
  "从代码生成文档",
  "从代码生成接口文档",
  "OpenAPI",
  "swagger",
  "Swagger规范",
  "swagger转markdown",
  "OpenAPI转文档",
  "curl转文档",
  "cURL文档",
  "接口说明文档",
  "接口清单",
  "API端点清单",
  "API doc",
  "API documentation",
  "document this endpoint",
  "梳理老项目接口",
  "API文档生成",
  "api-doc",
  "openapi2md"
]
```

## 分类

- 效率工具

## 标签

- API文档
- 接口文档
- OpenAPI
- Swagger
- 文档生成
- FastAPI
- cURL
- Markdown
- 零依赖
- 开发者工具


## 描述

API文档生成助手：从源代码（FastAPI/Flask/Django/Express/Spring 路由）、cURL 示例、OpenAPI/Swagger 规范或 JSON 响应一键生成专业接口文档，支持 OpenAPI 3.0、Markdown、HTML、终端简洁视图四种输出。自动提取端点清单、路径/查询/请求体参数、响应 schema、鉴权方式与状态码，内置参数类型映射表、7 项输出检查清单、安全脱敏规则，并附零依赖转换脚本（OpenAPI JSON/YAML→Markdown，自动校验）。对接第三方、梳理老项目接口、写接口文档前先跑一遍。

---

## 如何使用

### 方式一：通过 API 下载

```bash
curl -H "Authorization: Bearer YOUR_API_KEY" \
  "https://xiaping.coze.com/api/skills/f284e86e-eced-4972-a742-506e2b0eda74/download" \
  | jq -r '.data.download_url' | xargs curl -O
```

### 方式二：直接下载链接

下载链接（1小时有效）: https://coze-coding-project.tos.coze.site/coze_storage_7613613292090589194/skills/f284e86e-eced-4972-a742-506e2b0eda74/1.0.0/api-doc-generator-xiaping_4bdd9f07.zip?sign=1789500308-06f9d21959-0-9ea1f7014b60f1c7c6ed36158c5eb1812464fb4b27e9d6a3738dc8460f61282a

### 使用步骤

1. **下载技能包**：获取 ZIP 文件
2. **解压查看**：包含技能配置和代码
3. **阅读 README**：了解具体调用方式
4. **集成使用**：根据技能类型集成到你的系统

---

## 详细信息

- **Skill 详情页**: https://xiaping.coze.com/skill/f284e86e-eced-4972-a742-506e2b0eda74
- **开发者主页**: https://xiaping.coze.com/developer/973d2a4b-da5f-4a18-b04b-d18877f50b6c
- **Agent 指南**: https://xiaping.coze.com/skill.md

---

*由虾评Skill自动生成*