Convert Swagger & OpenAPI Specs to Clean Markdown
Transform raw Swagger JSON and OpenAPI YAML files into beautiful, publication-ready API documentation, READMEs, and developer portal guides in under 15ms.
- Free, no watermark
- No sign-up
- Files never leave your browser
# Acme Cloud Compute & Container API `v2.4.0`
High-performance cloud orchestration service for serverless compute and container deployments.
**Base URL:** `https://api.acmecloud.io/v2`
---
## ๐ API Endpoints Index
| Method | Endpoint | Summary |
| :--- | :--- | :--- |
| `GET` | [/v2/clusters](#get-v2clusters) | List all active compute clusters |
| `GET` | [/v2/clusters/{clusterId}](#get-v2clustersclusterId) | Retrieve cluster details by ID |
| `DELETE` | [/v2/clusters/{clusterId}](#delete-v2clustersclusterId) | Terminate and de-provision a cluster |
| `POST` | [/v2/deployments](#post-v2deployments) | Deploy new container workload |
---
## ๐ท๏ธ Clusters
### `GET` /v2/clusters <a id="get-v2clusters"></a>
**List all active compute clusters**
#### ๐ฅ Parameters
| Name | In | Type | Required | Description |
| :--- | :---: | :---: | :---: | :--- |
| `region` | `query` | `enum ("us-east-1" | "us-west-2" | "eu-central-1")` | No | Filter clusters by cloud availability zone |
| `limit` | `query` | `integer` | No | Maximum number of clusters to return (1-100) |
#### ๐ค Responses
| Status Code | Description | Content Type |
| :---: | :--- | :--- |
| `200` | Array of active cluster summaries | `application/json` |
**Response Example:**
```json
{
"total": 3,
"clusters": [
{
"id": "cls_99182a",
"name": "us-east-prod-pool",
"nodes": 32,
"status": "RUNNING"
}
]
}
```
#### ๐ป Example cURL
```bash
curl -X GET "https://api.acmecloud.io/v2/clusters?region=sample&limit=sample" \
-H "Accept: application/json"
```
---
### `GET` /v2/clusters/{clusterId} <a id="get-v2clustersclusterId"></a>
**Retrieve cluster details by ID**
#### ๐ฅ Parameters
| Name | In | Type | Required | Description |
| :--- | :---: | :---: | :---: | :--- |
| `clusterId` | `path` | `string` | **Yes** | Unique cluster UUID |
#### ๐ค Responses
| Status Code | Description | Content Type |
| :---: | :--- | :--- |
| `200` | Detailed cluster configuration | `application/json` |
| `404` | Cluster not found | `-` |
**Response Example:**
```json
{
"id": "cls_99182a",
"name": "us-east-prod-pool",
"kubernetesVersion": "1.30.2",
"cpuUtilization": 74.2
}
```
#### ๐ป Example cURL
```bash
curl -X GET "https://api.acmecloud.io/v2/clusters/123" \
-H "Accept: application/json"
```
---
### `DELETE` /v2/clusters/{clusterId} <a id="delete-v2clustersclusterId"></a>
**Terminate and de-provision a cluster**
#### ๐ฅ Parameters
| Name | In | Type | Required | Description |
| :--- | :---: | :---: | :---: | :--- |
| `clusterId` | `path` | `string` | **Yes** | Unique cluster UUID |
#### ๐ค Responses
| Status Code | Description | Content Type |
| :---: | :--- | :--- |
| `204` | Cluster scheduled for graceful termination | `-` |
#### ๐ป Example cURL
```bash
curl -X DELETE "https://api.acmecloud.io/v2/clusters/123" \
-H "Accept: application/json"
```
---
## ๐ท๏ธ Workloads
### `POST` /v2/deployments <a id="post-v2deployments"></a>
**Deploy new container workload**
#### ๐ฆ Request Body
**Content-Type:** `application/json`
```json
{
"image": "acme/api-worker:v2.4.0",
"replicas": 5,
"cpuLimitCores": 2,
"memoryLimitMB": 4096
}
```
#### ๐ค Responses
| Status Code | Description | Content Type |
| :---: | :--- | :--- |
| `201` | Container workload successfully deployed | `application/json` |
**Response Example:**
```json
{
"deploymentId": "dep_01928374",
"status": "DEPLOYING"
}
```
#### ๐ป Example cURL
```bash
curl -X POST "https://api.acmecloud.io/v2/deployments" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-d '{
"image": "acme/api-worker:v2.4.0",
"replicas": 5,
"cpuLimitCores": 2,
"memoryLimitMB": 4096
}'
```
---
How to Convert Swagger to Markdown in 3 Simple Steps
No installation or registration required. Follow these steps to convert and export your files in seconds.
Paste Swagger Spec
Paste your raw OpenAPI 3.0 / 3.1 YAML or Swagger 2.0 JSON specification into the left editor.
Instant In-Browser Parsing
The spec is parsed in memory in your browser: endpoints, parameters and status codes.
Copy or Export Markdown
Copy the generated GitHub Flavored Markdown or download it directly as a `.md` file for your docs.
Swagger to Markdown: Example Conversion
The output below was generated by the same converter that runs in the tool above, from one of its built-in samples. Load that sample in the editor to try your own changes.
openapi: 3.0.3
info:
title: Zero-Trust Identity Provider API
version: 2.0.0
description: OAuth 2.1 authorization server with PKCE and refresh token rotation.
servers:
- url: https://auth.enterprise.org
paths:
/oauth/token:
post:
summary: Exchange authorization code or refresh token
requestBody:
required: true
content:
application/json:
example:
grant_type: "authorization_code"
code: "SplxlOBeZQQYbYS6WxSbIA"
code_verifier: "dBjftJeZ4CVP-mB92K27uhbUJU1p1r_wW1gFWFOEjXk"
client_id: "portal-web-client"
responses:
"200":
description: Access token bundle
content:
application/json:
example:
access_token: "eyJhbGciOiJSUzI1NiIsIn..."
token_type: "Bearer"
expires_in: 3600
refresh_token: "r_019283749102"# Zero-Trust Identity Provider API `v2.0.0`
OAuth 2.1 authorization server with PKCE and refresh token rotation.
**Base URL:** `https://auth.enterprise.org`
---
## ๐ API Endpoints Index
| Method | Endpoint | Summary |
| :--- | :--- | :--- |
| `POST` | [/oauth/token](#post-oauthtoken) | Exchange authorization code or refresh token |
---
## ๐ท๏ธ General
### `POST` /oauth/token <a id="post-oauthtoken"></a>
**Exchange authorization code or refresh token**
#### ๐ฆ Request Body
**Content-Type:** `application/json`
```json
{
"grant_type": "authorization_code",
"code": "SplxlOBeZQQYbYS6WxSbIA",
"code_verifier": "dBjftJeZ4CVP-mB92K27uhbUJU1p1r_wW1gFWFOEjXk",
"client_id": "portal-web-client"Long samples are shortened here; the tool converts the full document.
Known Limitations of Swagger to Markdown
What this converter does not do (yet), and what to do instead.
- Schema references ($ref) are listed but example responses are not generated from them, so response examples may show {} โ add examples to your spec for richer docs.
- Callbacks, webhooks and links (OpenAPI 3.1 features) are not documented.
- Authentication flows are summarised, not documented step by step.
- Very large specs (hundreds of endpoints) produce long single pages; split the spec by tag if needed.
Swagger / OpenAPI โ Markdown Syntax Cheat Sheet & Reference Guide
Side-by-side syntax comparison and quick reference guide. Look up how headings, code blocks, tables, and typography elements translate between Swagger / OpenAPI and Markdown. Click any snippet to copy.
Swagger / OpenAPI vs. Markdown โ Deep Feature Analysis
Understanding the architectural trade-offs, ecosystem compatibility, and optimal workflows for each format.
When to Use Swagger / OpenAPI
Best for fast, distraction-free drafting, Git version-controlled documentation, developer pull requests, and multi-format source authoring.
When to Convert to Markdown
Best for delivering formal client assets, corporate stakeholder review, publication on specialized platforms, or high-fidelity visual presentation.
Who Relies on Swagger to Markdown?
Explore how engineering teams, technical writers, and data analysts streamline daily operations.
README API Documentation
Quickly document microservice endpoints directly in GitHub repository READMEs without running heavy documentation servers.
Static Documentation Sites
Generate source `.md` files for Docusaurus, VitePress, or GitBook sites directly from CI/CD generated OpenAPI specs.
Internal Engineering Wikis
Convert internal Swagger JSON specs into clean Markdown pages for Notion, Confluence, and GitHub Wikis.
Pro Tips & Edge Cases Handled for Swagger to Markdown
Practical advice for achieving high-fidelity conversions and resolving syntax edge cases.
Developer Pro Tips
- Group your routes using OpenAPI
tagsto automatically generate organized section headers and categorized tables in your Markdown output. - Add
examplevalues to your parameters and response schemas in your Swagger file to auto-populate high-fidelity sample payloads in the generated Markdown. - Use the generated cURL code blocks directly in your API onboarding guides for instant developer testing.
Edge Cases Resolved Automatically
in: body parameters instead of OpenAPI 3.0 requestBodyFrequently Asked Questions About Swagger to Markdown
Comprehensive answers to common technical, formatting, security, and compatibility questions.
servers arrays or host/basePath definitions and seamlessly normalizes parameters.How the Swagger / OpenAPI to Markdown Engine Works
Every step below runs in your browser tab; your content is never sent to a server.
Pipeline Architecture Specification
MDConverter reads OpenAPI/Swagger specifications via a high-performance in-memory parser. It extracts the info metadata, builds an endpoint table of contents, parses parameter definitions into GFM tables, renders request/response bodies into JSON code blocks, and constructs executable curl commands for every route.
Why Choose MDConverter for Swagger to Markdown?
100% Client-Side Privacy & Security Guarantee
Unlike online converters that upload your files to a remote server, MDConverter runs every conversion with JavaScript inside your browser tab. Your documents are never uploaded, so they never leave your machine.
Related Converters
Turn Jupyter notebooks and OpenAPI/Swagger specs into Markdown, and move papers between LaTeX and Markdown.