OpenAPI to TypeScript

v1.0.2

Generate TypeScript interface definitions from OpenAPI 3.0 JSON/YAML specifications.

Generates TypeScript interface definitions from OpenAPI 3.0 JSON or YAML specifications — maps schemas, request bodies, and response types to typed TS interfaces for use with fetch wrappers.

How to use

→Paste an OpenAPI 3.0 JSON or YAML spec into the input.
→The generated TypeScript types correspond to schema components and endpoint payloads.
→Copy the types into a types.ts file in your project.

OpenAPI / Swagger YAML

openapi: "3.0.0"
info:
  title: Sample API
  version: "1.0.0"
paths:
  /users:
    get:
      operationId: getUsers
      summary: List users
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: "#/components/schemas/User"
    post:
      operationId: createUser
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/CreateUser"
      responses:
        "201":
          description: Created
  /users/{id}:
    get:
      operationId: getUserById
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
      responses:
        "200":
          description: OK
components:
  schemas:
    User:
      type: object
      required: [id, name, email]
      properties:
        id:
          type: string
        name:
          type: string
        email:
          type: string
        age:
          type: integer
        active:
          type: boolean
    CreateUser:
      type: object
      required: [name, email]
      properties:
        name:
          type: string
        email:
          type: string

TypeScript Types