Which OpenAPI and Swagger specification versions are supported?

ToolsAA supports OpenAPI 3.1.x, OpenAPI 3.0.x, and legacy Swagger 2.0 specifications formatted in either YAML or JSON.

Is my proprietary API specification uploaded to external servers or logged?

No. The entire YAML/JSON parsing, schema dereferencing, and Markdown formatting pipeline operates 100% client-side in your local browser memory.

Are generated Markdown files compatible with GitHub, GitLab, and Bitbucket?

Yes. All output strictly complies with GitHub Flavored Markdown (GFM) specifications, including pipe tables, syntax-highlighted code fences, and standard heading anchors.

How does the generator handle multipart/form-data and binary file uploads?

Endpoints accepting multipart/form-data or application/x-www-form-urlencoded are documented with dedicated parameter tables and appropriate cURL -F flags for file uploads.

OpenAPI & Swagger to Markdown API Documentation Generator

Convert OpenAPI 3.0 and Swagger 2.0 JSON/YAML specifications into clean GitHub Flavored Markdown API reference documentation.

Presets:

Markdown Generator Architecture & Settings

OpenAPI 3.0.3 · YAML

Grouping:

API Title: Aurora Commerce Engine API·Version: 2.4.0·Servers: 2

Pure Browser AST Translation · 100% Client-Side Private

OpenAPI / Swagger Specification (YAML or JSON)YAMLOpenAPI 3.0.3

openapi: 3.0.3
info:
  title: Aurora Commerce Engine API
  version: 2.4.0
  description: High-throughput headless commerce API offering order lifecycle management, product catalog indexing, and customer checkout flows.
  contact:
    name: API Platform Team
    email: api-support@auroracommerce.io
    url: https://auroracommerce.io/developers
  license:
    name: Apache 2.0
    url: https://www.apache.org/licenses/LICENSE-2.0.html
servers:
  - url: https://api.auroracommerce.io/v2
    description: Production Cluster (Global Anycast)
  - url: https://staging-api.auroracommerce.io/v2
    description: Sandbox Staging Environment
components:
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: Enter your signed JWT authorization token in the format 'Bearer <token>'.
  schemas:
    Order:
      type: object
      description: Complete customer purchase record and fulfillment state.
      required:
        - id
        - customerId
        - items
        - totalAmount
        - currency
        - status
      properties:
        id:
          type: string
          format: uuid
          example: 9b1deb4d-3b7d-4bad-9bdd-2b0d7b3dcb6d
          description: Unique immutable order identifier.
        customerId:
          type: string
          example: cust_894321
          description: Associated customer identifier.
        items:
          type: array
          description: List of purchased items.
          items:
            $ref: '#/components/schemas/OrderItem'
        totalAmount:
          type: number
          format: double
          example: 249.99
          description: Net order balance in standard monetary units.
        currency:
          type: string
          example: USD
          description: ISO-4217 three-letter currency code.
        status:
          type: string
          enum: [pending, paid, processing, shipped, delivered, cancelled]
          example: paid
          description: Current fulfillment lifecycle state.
    OrderItem:
      type: object
      required:
        - sku
        - quantity
        - unitPrice
      properties:
        sku:
          type: string
          example: PROD-KB-900
          description: Stock Keeping Unit identifier.
        quantity:
          type: integer
          example: 2
          description: Number of units purchased.
        unitPrice:
          type: number
          example: 99.99
          description: Price per unit at time of purchase.
    CreateOrderRequest:
      type: object
      required:
        - customerId
        - items
        - currency
      properties:
        customerId:
          type: string
          example: cust_894321
        items:
          type: array
          items:
            $ref: '#/components/schemas/OrderItem'
        currency:
          type: string
          example: USD
        shippingAddress:
          type: string
          example: "742 Evergreen Terrace, Springfield, OR"
    ApiError:
      type: object
      required:
        - code
        - message
      properties:
        code:
          type: string
          example: ORDER_NOT_FOUND
          description: Machine-readable error code.
        message:
          type: string
          example: The requested order was not found.
          description: Human-readable error message.
paths:
  /orders:
    get:
      tags:
        - Orders
      summary: List Customer Orders
      description: Retrieves a paginated collection of historical orders filtered by status or date range.
      operationId: listOrders
      security:
        - BearerAuth: []
      parameters:
        - name: status
          in: query
          required: false
          schema:
            type: string
            enum: [pending, paid, shipped, cancelled]
          description: Filter orders by current fulfillment state.
        - name: limit
          in: query
          required: false
          schema:
            type: integer
            default: 20
          description: Maximum number of orders to return per page.
        - name: cursor
          in: query
          required: false
          schema:
            type: string
          description: Opaque pagination cursor from previous response.
      responses:
        '200':
          description: Successfully retrieved order collection.
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Order'
        '401':
          description: Missing or invalid JWT authorization header.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
    post:
      tags:
        - Orders
      summary: Create New Order
      description: Validates inventory reserves, charges default payment method, and records a new order.
      operationId: createOrder
      security:
        - BearerAuth: []
      requestBody:
        description: Order items and checkout details.
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateOrderRequest'
      responses:
        '201':
          description: Order successfully created and queued for processing.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Order'
        '422':
          description: Validation failure or insufficient stock.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
  /orders/{orderId}:
    get:
      tags:
        - Orders
      summary: Retrieve Order by ID
      description: Fetches full details for an individual order including shipping tracking codes.
      operationId: getOrderById
      security:
        - BearerAuth: []
      parameters:
        - name: orderId
          in: path
          required: true
          schema:
            type: string
            format: uuid
          description: Target order UUID.
      responses:
        '200':
          description: Order details found.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Order'
        '404':
          description: Specified order does not exist.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'

222 Lines:6524 chars6.4 KB

3 Operations Detected

# 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 Lines:8199 chars8.0 KB

GFM Compliant

API Operations

3 Endpoints

Data Models

4 Schemas

Markdown Output

315 Lines: / 8.0 KB

Zero-Knowledge Local Execution

Instant OpenAPI 3.0/3.1 and Swagger 2.0 parsing and GFM generation executed entirely in browser memory.

Sub-Millisecond AST Engine

Proprietary API specs and internal schemas never leave your device. Complete zero-server privacy.

GitHub Flavored Markdown

Clean tables, syntax-highlighted examples, and structured reference sections ready for GitBook, VitePress, or README.