Đặc tả (JSON hoặc YAML)

openapi: 3.0.3
info:
  title: Petstore API
  version: 1.2.0
  description: A small pet store used to demonstrate the OpenAPI toolkit.
servers:
  - url: https://{env}.petstore.example.com/v1
    variables:
      env:
        default: api
        enum: [api, sandbox]
tags:
  - name: pets
    description: Everything about your pets
  - name: store
    description: Orders
security:
  - apiKey: []
paths:
  /pets:
    get:
      tags: [pets]
      summary: List pets
      operationId: listPets
      parameters:
        - name: limit
          in: query
          description: How many items to return (max 100)
          required: false
          schema:
            type: integer
            format: int32
            default: 20
        - name: status
          in: query
          schema:
            $ref: '#/components/schemas/PetStatus'
      responses:
        '200':
          description: A page of pets
          headers:
            x-next:
              description: Link to the next page
              schema:
                type: string
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Pet'
        default:
          $ref: '#/components/responses/Error'
    post:
      tags: [pets]
      summary: Create a pet
      operationId: createPet
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/NewPet'
      responses:
        '201':
          description: Created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Pet'
        default:
          $ref: '#/components/responses/Error'
  /pets/{petId}:
    parameters:
      - name: petId
        in: path
        required: true
        description: The id of the pet
        schema:
          type: integer
          format: int64
          example: 42
    get:
      tags: [pets]
      summary: Get a pet by id
      operationId: getPet
      responses:
        '200':
          description: The pet
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Pet'
        '404':
          $ref: '#/components/responses/Error'
    delete:
      tags: [pets]
      summary: Delete a pet
      operationId: deletePet
      deprecated: true
      security:
        - bearerAuth: []
      responses:
        '204':
          description: Deleted
  /store/orders:
    post:
      tags: [store]
      summary: Place an order
      operationId: placeOrder
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Order'
      responses:
        '200':
          description: The order
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Order'
components:
  securitySchemes:
    apiKey:
      type: apiKey
      in: header
      name: X-API-Key
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
  responses:
    Error:
      description: Unexpected error
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
  schemas:
    PetStatus:
      type: string
      enum: [available, pending, sold]
    NewPet:
      type: object
      required: [name]
      properties:
        name:
          type: string
          example: Rex
        tag:
          type: string
          nullable: true
        status:
          $ref: '#/components/schemas/PetStatus'
        category:
          $ref: '#/components/schemas/Category'
    Pet:
      allOf:
        - $ref: '#/components/schemas/NewPet'
        - type: object
          required: [id]
          properties:
            id:
              type: integer
              format: int64
              readOnly: true
    Category:
      type: object
      description: A category can contain sub-categories.
      properties:
        id:
          type: integer
        name:
          type: string
        children:
          type: array
          items:
            $ref: '#/components/schemas/Category'
    Order:
      type: object
      required: [petId, quantity]
      properties:
        petId:
          type: integer
          format: int64
        quantity:
          type: integer
          minimum: 1
        shipDate:
          type: string
          format: date-time
    Error:
      type: object
      required: [code, message]
      properties:
        code:
          type: integer
        message:
          type: string

OpenAPI 3.0

YAML

5 endpoint

6 schema

Trình xem

Kiểm tra

So sánh

Chuyển đổi & xuất

Petstore API

1.2.0

A small pet store used to demonstrate the OpenAPI toolkit.

Máy chủ: https://{env}.petstore.example.com/v1

Cơ chế bảo mật: apiKey · apiKey · header · X-API-KeybearerAuth · http · bearer

Mọi method

Mọi tag

pets

(4)

GET

/pets

List pets

POST

/pets

Create a pet

GET

/pets/{petId}

Get a pet by id

DELETE

/pets/{petId}

Delete a pet

ngừng hỗ trợ

store

(1)

Danh sách schema (6)

PetStatus

"available" | "pending" | "sold"

NewPet

object

Pet

NewPet & object

Category

object

Order

object

Error

object

Đặc tả (JSON hoặc YAML)

OpenAPI 3.0

YAML

5 endpoint

6 schema

Trình xem

Kiểm tra

So sánh

Chuyển đổi & xuất

Petstore API

1.2.0

A small pet store used to demonstrate the OpenAPI toolkit.

Máy chủ: https://{env}.petstore.example.com/v1

Cơ chế bảo mật: apiKey · apiKey · header · X-API-KeybearerAuth · http · bearer

Mọi method

Mọi tag

pets

(4)

GET

/pets

List pets

POST

/pets

Create a pet

GET

/pets/{petId}

Get a pet by id

DELETE

/pets/{petId}

Delete a pet

ngừng hỗ trợ

store

(1)

Danh sách schema (6)

PetStatus

"available" | "pending" | "sold"

NewPet

object

Pet

NewPet & object

Category

object

Order

object

Error

object

Bộ công cụ OpenAPI / Swagger

Toolbox

Đánh giá & bình luận

Bộ công cụ OpenAPI / Swagger

Đánh giá & bình luận