Created
April 5, 2018 18:11
-
-
Save AMcManigal/0a1b973c6da8f0bbd2f1a1d591e6093d to your computer and use it in GitHub Desktop.
Petstore With Request Body Example
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
openapi: "3.0.0" | |
info: | |
version: 1.0.0 | |
title: Swagger Petstore | |
license: | |
name: MIT | |
servers: | |
- url: http://petstore.swagger.io/v1 | |
paths: | |
/pets: | |
get: | |
summary: List all pets | |
operationId: listPets | |
tags: | |
- pets | |
parameters: | |
- name: limit | |
in: query | |
description: How many items to return at one time (max 100) | |
required: false | |
schema: | |
type: integer | |
format: int32 | |
responses: | |
'200': | |
description: An paged array of pets | |
headers: | |
x-next: | |
description: A link to the next page of responses | |
schema: | |
type: string | |
content: | |
application/json: | |
schema: | |
$ref: "#/components/schemas/Pets" | |
default: | |
description: unexpected error | |
content: | |
application/json: | |
schema: | |
$ref: "#/components/schemas/Error" | |
post: | |
summary: Create a pet | |
operationId: createPets | |
tags: | |
- pets | |
requestBody: | |
content: | |
application/json: | |
schema: | |
$ref: "#/components/schemas/Pet" | |
responses: | |
'201': | |
description: Null response | |
default: | |
description: unexpected error | |
content: | |
application/json: | |
schema: | |
$ref: "#/components/schemas/Error" | |
/pets/{petId}: | |
get: | |
summary: Info for a specific pet | |
operationId: showPetById | |
tags: | |
- pets | |
parameters: | |
- name: petId | |
in: path | |
required: true | |
description: The id of the pet to retrieve | |
schema: | |
type: string | |
responses: | |
'200': | |
description: Expected response to a valid request | |
content: | |
application/json: | |
schema: | |
$ref: "#/components/schemas/Pets" | |
default: | |
description: unexpected error | |
content: | |
application/json: | |
schema: | |
$ref: "#/components/schemas/Error" | |
components: | |
schemas: | |
Pet: | |
required: | |
- id | |
- name | |
properties: | |
id: | |
type: integer | |
format: int64 | |
name: | |
type: string | |
tag: | |
type: string | |
Pets: | |
type: array | |
items: | |
$ref: "#/components/schemas/Pet" | |
Error: | |
required: | |
- code | |
- message | |
properties: | |
code: | |
type: integer | |
format: int32 | |
message: | |
type: string |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment