OpenAPI・Swagger Markdown API仕様書生成ツール

OpenAPI・Swagger Markdown API仕様書生成ツール

OpenAPI 3.0/3.1およびSwagger 2.0のJSON/YAML仕様書を、GitHub Flavored Markdown（GFM）準拠の美しいAPIリファレンスへ高速変換。

Presets:
Markdownジェネレーター構成と設定
グループ化:
APIタイトル: Aurora Commerce Engine API·Version: 2.4.0·Servers: 2
OpenAPI / Swagger 仕様書 (YAML または JSON)YAML
222 行数:6524 chars6.4 KB
3 件のオペレーションを検出
# Aurora Commerce Engine API

> **Version:** `2.4.0`  
> **Specification:** `OpenAPI 3.0.3`  
> **Generated At:** `2026-10-21` via [ToolsAA](https://toolsaa.com)

High-throughput headless commerce API offering order lifecycle management, product catalog indexing, and customer checkout flows.

---

## Base URLs & Servers

| Environment / Description | Server URL |
|:---|:---|
| Production Cluster (Global Anycast) | `https://api.auroracommerce.io/v2` |
| Sandbox Staging Environment | `https://staging-api.auroracommerce.io/v2` |

## Authentication & Security

| Scheme Name | Type | Location / Format | Description |
|:---|:---|:---|:---|
| **`BearerAuth`** | `http` | Format: `bearer` | Enter your signed JWT authorization token in the format 'Bearer <token>'. |

## Table of Contents

- **Orders**
  - [`GET` `/orders`](#get--orders) - List Customer Orders
  - [`POST` `/orders`](#post--orders) - Create New Order
  - [`GET` `/orders/{orderId}`](#get--orders--orderid-) - Retrieve Order by ID
- **Data Models & Schemas**
  - [`Order`](#schema-order)
  - [`OrderItem`](#schema-orderitem)
  - [`CreateOrderRequest`](#schema-createorderrequest)
  - [`ApiError`](#schema-apierror)

---

## API Endpoints Reference

## Tag: Orders

### <a id="get--orders"></a>`GET` /orders

**List Customer Orders**

Retrieves a paginated collection of historical orders filtered by status or date range.

- **Operation ID:** `listOrders`
- **Security:** `BearerAuth`

#### Parameters

| Name | Located In | Type | Required | Description | Example / Default |
|:---|:---|:---|:---:|:---|:---|
| `status` | `query` | `string` | No | Filter orders by current fulfillment state. | - |
| `limit` | `query` | `integer` | No | Maximum number of orders to return per page. | Def: `20` |
| `cursor` | `query` | `string` | No | Opaque pagination cursor from previous response. | - |

#### Responses

| Status Code | Description | Schema Type |
|:---|:---|:---|
| `200` | Successfully retrieved order collection. | `Order[]` |
| `401` | Missing or invalid JWT authorization header. | `ApiError` |

##### Example Response (`200`)
```json
[
  {
    "id": "9b1deb4d-3b7d-4bad-9bdd-2b0d7b3dcb6d",
    "customerId": "cust_894321",
    "items": [
      {
        "sku": "PROD-KB-900",
        "quantity": 2,
        "unitPrice": 99.99
      }
    ],
    "totalAmount": 249.99,
    "currency": "USD",
    "status": "paid"
  }
]
```

#### cURL Example
```bash
curl -X GET "https://api.auroracommerce.io/v2/orders" \
  -H "Authorization: Bearer <ACCESS_TOKEN>" \
  -H "Accept: application/json"
```

---

### <a id="post--orders"></a>`POST` /orders

**Create New Order**

Validates inventory reserves, charges default payment method, and records a new order.

- **Operation ID:** `createOrder`
- **Security:** `BearerAuth`

#### Request Body

- **Content-Type:** `application/json`
- **Required:** **Yes**
- **Description:** Order items and checkout details.

| Property | Type | Required | Description | Example |
|:---|:---|:---:|:---|:---|
| `customerId` | `string` | **Yes** | - | `cust_894321` |
| `items` | `OrderItem[]` | **Yes** | - | - |
| `currency` | `string` | **Yes** | - | `USD` |
| `shippingAddress` | `string` | No | - | `742 Evergreen Terrace, Springfield, OR` |

##### Example Request Payload
```json
{
  "customerId": "cust_894321",
  "items": [
    {
      "sku": "PROD-KB-900",
      "quantity": 2,
      "unitPrice": 99.99
    }
  ],
  "currency": "USD",
  "shippingAddress": "742 Evergreen Terrace, Springfield, OR"
}
```

#### Responses

| Status Code | Description | Schema Type |
|:---|:---|:---|
| `201` | Order successfully created and queued for processing. | `Order` |
| `422` | Validation failure or insufficient stock. | `ApiError` |

##### Example Response (`201`)
```json
{
  "id": "9b1deb4d-3b7d-4bad-9bdd-2b0d7b3dcb6d",
  "customerId": "cust_894321",
  "items": [
    {
      "sku": "PROD-KB-900",
      "quantity": 2,
      "unitPrice": 99.99
    }
  ],
  "totalAmount": 249.99,
  "currency": "USD",
  "status": "paid"
}
```

#### cURL Example
```bash
curl -X POST "https://api.auroracommerce.io/v2/orders" \
  -H "Authorization: Bearer <ACCESS_TOKEN>" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{ "customerId": "cust_894321", "items": [ { "sku": "PROD-KB-900", "quantity": 2, "unitPrice": 99.99 } ], "currency": "USD", "shippingAddress": "742 Evergreen Terrace, Springfield, OR" }'
```

---

### <a id="get--orders--orderid-"></a>`GET` /orders/{orderId}

**Retrieve Order by ID**

Fetches full details for an individual order including shipping tracking codes.

- **Operation ID:** `getOrderById`
- **Security:** `BearerAuth`

#### Parameters

| Name | Located In | Type | Required | Description | Example / Default |
|:---|:---|:---|:---:|:---|:---|
| `orderId` | `path` | `string (uuid)` | **Yes** | Target order UUID. | - |

#### Responses

| Status Code | Description | Schema Type |
|:---|:---|:---|
| `200` | Order details found. | `Order` |
| `404` | Specified order does not exist. | `ApiError` |

##### Example Response (`200`)
```json
{
  "id": "9b1deb4d-3b7d-4bad-9bdd-2b0d7b3dcb6d",
  "customerId": "cust_894321",
  "items": [
    {
      "sku": "PROD-KB-900",
      "quantity": 2,
      "unitPrice": 99.99
    }
  ],
  "totalAmount": 249.99,
  "currency": "USD",
  "status": "paid"
}
```

#### cURL Example
```bash
curl -X GET "https://api.auroracommerce.io/v2/orders/{orderId}" \
  -H "Authorization: Bearer <ACCESS_TOKEN>" \
  -H "Accept: application/json"
```

---

## Data Models & Schemas

### <a id="schema-order"></a>Schema: `Order`

> Complete customer purchase record and fulfillment state.

| Property | Type | Required | Description | Example |
|:---|:---|:---:|:---|:---|
| `id` | `string (uuid)` | **Yes** | Unique immutable order identifier. | `9b1deb4d-3b7d-4bad-9bdd-2b0d7b3dcb6d` |
| `customerId` | `string` | **Yes** | Associated customer identifier. | `cust_894321` |
| `items` | `OrderItem[]` | **Yes** | List of purchased items. | - |
| `totalAmount` | `number (double)` | **Yes** | Net order balance in standard monetary units. | `249.99` |
| `currency` | `string` | **Yes** | ISO-4217 three-letter currency code. | `USD` |
| `status` | `string` | **Yes** | Current fulfillment lifecycle state. | `paid` |

#### Sample JSON Representation
```json
{
  "id": "9b1deb4d-3b7d-4bad-9bdd-2b0d7b3dcb6d",
  "customerId": "cust_894321",
  "items": [
    {
      "sku": "PROD-KB-900",
      "quantity": 2,
      "unitPrice": 99.99
    }
  ],
  "totalAmount": 249.99,
  "currency": "USD",
  "status": "paid"
}
```

---

### <a id="schema-orderitem"></a>Schema: `OrderItem`

| Property | Type | Required | Description | Example |
|:---|:---|:---:|:---|:---|
| `sku` | `string` | **Yes** | Stock Keeping Unit identifier. | `PROD-KB-900` |
| `quantity` | `integer` | **Yes** | Number of units purchased. | `2` |
| `unitPrice` | `number` | **Yes** | Price per unit at time of purchase. | `99.99` |

#### Sample JSON Representation
```json
{
  "sku": "PROD-KB-900",
  "quantity": 2,
  "unitPrice": 99.99
}
```

---

### <a id="schema-createorderrequest"></a>Schema: `CreateOrderRequest`

| Property | Type | Required | Description | Example |
|:---|:---|:---:|:---|:---|
| `customerId` | `string` | **Yes** | - | `cust_894321` |
| `items` | `OrderItem[]` | **Yes** | - | - |
| `currency` | `string` | **Yes** | - | `USD` |
| `shippingAddress` | `string` | No | - | `742 Evergreen Terrace, Springfield, OR` |

#### Sample JSON Representation
```json
{
  "customerId": "cust_894321",
  "items": [
    {
      "sku": "PROD-KB-900",
      "quantity": 2,
      "unitPrice": 99.99
    }
  ],
  "currency": "USD",
  "shippingAddress": "742 Evergreen Terrace, Springfield, OR"
}
```

---

### <a id="schema-apierror"></a>Schema: `ApiError`

| Property | Type | Required | Description | Example |
|:---|:---|:---:|:---|:---|
| `code` | `string` | **Yes** | Machine-readable error code. | `ORDER_NOT_FOUND` |
| `message` | `string` | **Yes** | Human-readable error message. | `The requested order was not found.` |

#### Sample JSON Representation
```json
{
  "code": "ORDER_NOT_FOUND",
  "message": "The requested order was not found."
}
```

---
315 行数:8199 chars8.0 KB
GFM完全準拠
APIオペレーション数
3 エンドポイント
データモデル数
4 スキーマ
出力Markdown
315 行数: / 8.0 KB

ブラウザ内ローカル処理

OpenAPI 3.0/3.1およびSwagger 2.0の構文解析からMarkdown生成まで、すべてブラウザ内でミリ秒完結。

完全なプライバシー保護

非公開API仕様書や社内エンドポイント定義が外部サーバーへ送信されることは一切ありません。

GitHub Flavored Markdown準拠

きれいなMarkdownテーブル、cURLコマンド、レスポンスJSON例が即座に生成され、GitBookやWikiに最適。

技術リファレンス＆アーキテクチャガイド

OpenAPI・Swagger Markdown API仕様書生成ツール — リファレンスガイド

OpenAPI 3.0/3.1およびSwagger 2.0のJSON/YAML仕様書を、GitHub Flavored Markdown（GFM）準拠の美しいAPIリファレンスへ高速変換。

主要パラメータ＆設定項目

groupBy'tag' | 'path'

APIエンドポイントの階層分類基準（OpenAPIタグ別またはURLパス順）を指定します。

初期値: 'tag'
includeTocboolean

素早いアンカー移動が可能なGitHub Flavored Markdown形式の目次（TOC）を出力先頭に生成します。

初期値: true
includeCurlboolean

HTTPメソッド、リクエストヘッダー、クエリ、モックボディを含む実行可能なcURLコマンド例を各エンドポイントに自動生成します。

初期値: true
includeExamplesboolean

スキーマ定義のexample属性やプロパティ型からリクエスト・レスポンスのサンプルJSONペイロードを合成・埋め込みます。

初期値: true
includeSchemasboolean

コンポーネントスキーマのプロパティ型、必須制約（required）、説明を網羅したデータモデルリファレンステーブルを末尾に追加します。

初期値: true

プロの活用テクニック＆推奨設定

静的ドキュメントサイト（SSG）との連携

生成されたGFM形式のMarkdownは、VitePress、Docusaurus、MkDocsなどにそのまま配置可能で、重いOpenAPIプラグインを導入せずに高速な開発者ポータルを構築できます。

タグ（tags）の整理による構造化

OpenAPI仕様書の各エンドポイントに「認証」「ユーザー管理」「Webhooks」などの適切なタグを付与することで、整理された見出し構成のドキュメントが自動生成されます。

スキーマのexample定義でcURLコードを充実化

スキーマの各フィールドにexampleやdefault値を定義しておくと、ジェネレーターが自動抽出し、コピー＆ペーストですぐに動く実用的なcURLコマンドが生成されます。

よくあるトラブルと解決策

YAML構文エラー：「Implicit map keys need to be on a single line」またはタブ文字エラー

YAML仕様書内のインデントにタブ文字（Tab）が含まれていないか確認し、コロン（:）を含む説明文はダブルクォートでエスケープしてください。

スキーマの循環参照（$ref）による無限ループや未解決警告

自己参照モデル（ツリー構造やコメントスレッドなど）が存在する場合、ツールは第1階層を正しく展開し、再帰的な循環は名前付きスキーマリンクとして安全に処理します。

よくある質問 (FAQ)

対応しているOpenAPIおよびSwaggerのバージョンは？▼

OpenAPI 3.1.x、OpenAPI 3.0.x、および旧バージョンのSwagger 2.0仕様書（YAML／JSON両形式）に完全対応しています。

入力した機密API仕様書が外部サーバーへ送信されることはありますか？▼

一切ありません。YAML/JSONの解析、参照解決（$ref dereference）、Markdown構築の全処理はお使いのブラウザ内メモリ上で100%完結します。

GitHubやGitLabのMarkdownレンダラーと完全な互換性がありますか？▼

はい。GitHub Flavored Markdown（GFM）標準に厳格に準拠しており、パイプ区切りテーブル、シンタックスハイライト付きコードブロック、アンカーリンクが正常に描画されます。

マルチパートフォーム（multipart/form-data）やバイナリ送信エンドポイントはどう記述されますか？▼

multipart/form-dataやapplication/x-www-form-urlencodedのエンドポイントは、専用パラメータテーブルとファイル送信フラグ（-F）付きのcURL例として出力されます。

関連するおすすめ開発ツール

すべてのツール →
GraphQL SDL Prisma スキーマ変換ツール開発ツール

GraphQL スキーマ定義言語（SDL）のオブジェクト型、Enum、ディレクティブを、クリーンで堅牢な Prisma ORM モデルおよびリレーション定義へ自動変換します。

ツールを開く→
SQL DDL から TypeORM エンティティ生成ツール（TypeScript エンティティ）開発ツール

SQL の CREATE TABLE DDL 文を、@Column、@PrimaryGeneratedColumn、リレーションデコレータを備えたクリーンな TypeScript TypeORM エンティティクラスに変換します。

ツールを開く→
SQL CREATE TABLE DDLからZodスキーマへのコンバーター開発ツール

SQLテーブルスキーマ、データ型、制約条件、NULL許容列を厳密に型付けされたTypeScript Zodオブジェクトスキーマに変換します。

ツールを開く→
Docker Compose から Kubernetes マニフェスト変換ツール（Compose to K8s）開発ツール

docker-compose.yml のサービス、環境変数、ポート公開、ボリューム設定を Kubernetes の Deployment および Service YAML マニフェストに完全変換します。

ツールを開く→
JSONから.env環境変数への変換ツール（平坦化とエクスポート）開発ツール

ネストされたJSONペイロードをカスタマイズ可能な区切り文字とプレフィックスオプションを使用して大文字SNAKE_CASEの.env設定に平坦化します。

ツールを開く→
SQL DDL から Drizzle ORM スキーマへの変換ジェネレーター (PostgreSQL, MySQL, SQLite)開発ツール

SQLのCREATE TABLE文を、pgTable、mysqlTable、sqliteTableの定義を含む型安全なDrizzle ORMスキーマコードに即座に変換します。

ツールを開く→