🛠 功能簡介

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 標準格式
• 僅用於文件結構轉換，不做接口有效性校驗