OpenAPI Viewer & Validator

Paste an OpenAPI 3.x or Swagger 2.0 document in JSON or YAML to check its structure and browse every endpoint by tag with parameters, request bodies and response schemas.

Spec, JSON or YAML

openapi: 3.0.3
info:
  title: Bookstore API
  version: 1.4.0
  description: Browse the catalogue and place orders.
servers:
  - url: https://api.bookstore.example/v1
tags:
  - name: books
    description: Catalogue
  - name: orders
    description: Checkout and order history
paths:
  /books:
    get:
      tags: [books]
      operationId: listBooks
      summary: List books
      parameters:
        - name: q
          in: query
          description: Full-text search on title and author
          schema:
            type: string
        - $ref: '#/components/parameters/Page'
      responses:
        '200':
          description: A page of books
          content:
            application/json:
              schema:
                type: object
                required: [data, total]
                properties:
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/Book'
                  total:
                    type: integer
  /books/{bookId}:
    get:
      tags: [books]
      operationId: getBook
      summary: Get a book
      parameters:
        - name: bookId
          in: path
          required: true
          schema:
            type: string
            format: uuid
      responses:
        '200':
          description: The book
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Book'
        '404':
          description: No book with this id
  /orders:
    post:
      tags: [orders]
      operationId: createOrder
      summary: Place an order
      security:
        - bearerAuth: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required: [items]
              properties:
                items:
                  type: array
                  items:
                    type: object
                    required: [bookId, quantity]
                    properties:
                      bookId:
                        type: string
                        format: uuid
                      quantity:
                        type: integer
                        minimum: 1
                coupon:
                  type: string
      responses:
        '201':
          description: Order created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Order'
        '422':
          description: Validation failed
components:
  parameters:
    Page:
      name: page
      in: query
      schema:
        type: integer
        default: 1
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
  schemas:
    Book:
      type: object
      required: [id, title, price]
      properties:
        id:
          type: string
          format: uuid
        title:
          type: string
        author:
          type: string
          nullable: true
        price:
          type: number
          format: double
    Order:
      type: object
      required: [id, status]
      properties:
        id:
          type: string
          format: uuid
        status:
          type: string
          enum: [pending, paid, shipped]
        books:
          type: array
          items:
            $ref: '#/components/schemas/Book'

Validation

Filter endpoints

Keyboard shortcuts

OpenAPI Viewer & Validator

Was this tool useful?