🛠 Feature Overview

The Swagger to Markdown tool allows you to instantly convert Swagger/OpenAPI interface documentation into structured Markdown documents, making it easy to organize, archive, and share API specifications.

🚀 How to Use

1. Upload a Swagger/OpenAPI file (e.g., .json), or paste the API documentation content directly.
2. Customize options such as whether to include titles and the starting number.
3. Generate the Markdown document with one click, ready to copy or download.

⚙️ Parameter Description

• File Upload Mode: Upload a local Swagger file to automatically convert it to Markdown.
• Text Mode: Paste Swagger content, supporting the following parameters:
  • need_title: Whether to generate a title for each endpoint (default: false).
  • start_no: The starting number for endpoint numbering (default: 1).

📋 Example

Input (Swagger JSON Example)

{
    "swagger": "2.0",
    "info": { "title": "API Example", "version": "1.0.0" },
    "paths": {
        "/user": {
            "get": {
                "summary": "Get user info",
                "responses": { "200": { "description": "Success" } }
            }
        }
    }
}

Output (Markdown Example)

# API Example API Documentation 1.0.0

## 1

### 1.1 Get user info

- **Path**: `/user`
- **Method**: `GET`
- **Description**:

#### Request Example

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

#### Response

##### 200

💡 Scenarios

• Quickly generate API documentation for team collaboration and integration
• Support for archiving API docs, API review, and knowledge base accumulation

📝 Notes

• Supports Swagger 2.0 and OpenAPI 3.0 standard formats
• Only converts document structure, does not validate API correctness