🛠 功能简介

Swagger 转 Markdown 工具可将 Swagger/OpenAPI 格式的接口文档一键转换为结构化的 Markdown 文档，便于接口说明的整理、归档和分享。

🚀 使用方法

1. 支持上传 Swagger/OpenAPI 文件（如 .json），或直接粘贴接口文档内容。
2. 可自定义是否需要标题、起始编号等参数。
3. 一键生成 Markdown 文档，可直接复制或下载。

⚙️ 参数说明

• 文件上传模式：上传本地 swagger 文件，自动转换为 markdown。
• 文本模式：粘贴 swagger 内容，支持如下参数：
  • need_title：是否需要为每个接口生成标题（默认 false）。
  • start_no：接口编号起始值（默认 1）。

📋 示例

输入（Swagger JSON 示例片段）

{
    "swagger": "2.0",
    "info": { "title": "API 示例", "version": "1.0.0" },
    "paths": {
        "/user": {
            "get": {
                "summary": "获取用户信息",
                "responses": { "200": { "description": "成功" } }
            }
        }
    }
}

输出（Markdown 示例片段）

# API 示例 API 文档 1.0.0

## 1 

### 1.1 获取用户信息

- **路径**: `/user`
- **方法**: `GET`
- **描述**: 

#### 请求示例

- `curl -X GET "http://xxx.com/user"`

#### 响应

##### 200

💡 应用场景

• 快速生成接口文档，便于团队协作和接口对接
• 支持接口文档归档、API 评审、知识库沉淀等

📝 注意事项

• 支持 Swagger 2.0 及 OpenAPI 3.0 标准格式
• 仅用于文档结构转换，不做接口有效性校验