OpenAPI / Swagger

The fastest way to get started. Paste any OpenAPI 3.0 or Swagger 2.0 spec and Invokix generates all outputs instantly — free on all plans.

What is OpenAPI

OpenAPI is the industry standard for describing REST APIs. If your backend already has a swagger.json, openapi.yaml, or an auto-generated spec from a framework like FastAPI, NestJS, or Express — you can import it directly.

How to import

Go to your project and click Import. Select OpenAPI / Swagger. Paste your spec as JSON or YAML and click Import. Invokix validates it instantly and generates all outputs.

Supported formats

  • OpenAPI 3.0 and 3.1 — JSON or YAML
  • Swagger 2.0 — JSON or YAML
  • Inline $ref references are resolved automatically

Example spec

openapi.yaml
openapi: 3.0.0
info:
title: Orders API
version: 1.0.0

paths:
/orders:
  get:
    summary: List orders
    responses:
      '200':
        description: OK
        content:
          application/json:
            schema:
              type: array
              items:
                $ref: '#/components/schemas/Order'
  post:
    summary: Create order
    requestBody:
      required: true
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/CreateOrderBody'
    responses:
      '201':
        description: Created
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Order'

components:
schemas:
  Order:
    type: object
    required: [id, price, status]
    properties:
      id:
        type: string
        format: uuid
      price:
        type: number
        minimum: 0
      status:
        type: string
        enum: [pending, shipped, delivered, cancelled]

  CreateOrderBody:
    type: object
    required: [price]
    properties:
      price:
        type: number
        minimum: 0

Next steps