Created
November 20, 2016 17:38
-
-
Save JeffML/afe889192968c1ca713131aee3e90a46 to your computer and use it in GitHub Desktop.
This file contains hidden or 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
swagger: '2.0' | |
info: | |
version: '1.0.0' | |
title: Swagger Petstore (Simple) | |
description: A sample API that uses a petstore as an example to demonstrate features in the swagger-2.0 specification | |
termsOfService: http://helloreverb.com/terms/ | |
contact: | |
name: Swagger API team | |
email: [email protected] | |
url: http://swagger.io | |
license: | |
name: MIT | |
url: http://opensource.org/licenses/MIT | |
host: petstore.swagger.io | |
basePath: /api | |
schemes: | |
- http | |
consumes: | |
- application/json | |
produces: | |
- application/json | |
paths: | |
/pets: | |
get: | |
description: Returns all pets from the system that the user has access to | |
operationId: findPets | |
produces: | |
- application/json | |
- application/xml | |
- text/xml | |
- text/html | |
parameters: | |
- name: tags | |
in: query | |
description: tags to filter by | |
required: false | |
type: array | |
items: | |
type: string | |
collectionFormat: csv | |
- name: limit | |
in: query | |
description: maximum number of results to return | |
required: false | |
type: integer | |
format: int32 | |
responses: | |
'200': | |
description: pet response | |
schema: | |
type: array | |
items: | |
$ref: '#/definitions/pet' | |
default: | |
description: unexpected error | |
schema: | |
$ref: '#/definitions/errorModel' | |
post: | |
description: Creates a new pet in the store. Duplicates are allowed | |
operationId: addPet | |
produces: | |
- application/json | |
parameters: | |
- name: pet | |
in: body | |
description: Pet to add to the store | |
required: true | |
schema: | |
type: object | |
required: | |
- pet | |
properties: | |
pet: | |
$ref: '#/definitions/newPet' | |
diet: | |
$ref: '#/definitions/diet' | |
responses: | |
'200': | |
description: pet response | |
schema: | |
$ref: '#/definitions/pet' | |
default: | |
description: unexpected error | |
schema: | |
$ref: '#/definitions/errorModel' | |
/pets/{id}: | |
get: | |
description: Returns a user based on a single ID, if the user does not have access to the pet | |
operationId: findPetById | |
produces: | |
- application/json | |
- application/xml | |
- text/xml | |
- text/html | |
parameters: | |
- name: id | |
in: path | |
description: ID of pet to fetch | |
required: true | |
type: integer | |
format: int64 | |
responses: | |
'200': | |
description: pet response | |
schema: | |
$ref: '#/definitions/pet' | |
default: | |
description: unexpected error | |
schema: | |
$ref: '#/definitions/errorModel' | |
delete: | |
description: deletes a single pet based on the ID supplied | |
operationId: deletePet | |
parameters: | |
- name: id | |
in: path | |
description: ID of pet to delete | |
required: true | |
type: integer | |
format: int64 | |
responses: | |
'204': | |
description: pet deleted | |
default: | |
description: unexpected error | |
schema: | |
$ref: '#/definitions/errorModel' | |
definitions: | |
pet: | |
type: object | |
required: | |
- id | |
- name | |
properties: | |
id: | |
type: integer | |
format: int64 | |
name: | |
type: string | |
format: petNameString | |
tag: | |
type: string | |
newPet: | |
type: object | |
required: | |
- name | |
properties: | |
id: | |
type: integer | |
format: int64 | |
name: | |
type: string | |
format: petNameString | |
tag: | |
type: string | |
breed: | |
type: string | |
enum: | |
- Shih Tzu | |
- French Bulldog | |
- Chow-Chow | |
diet: | |
$ref: '#/definitions/diet' | |
diet: | |
type: object | |
properties: | |
brand: | |
type: string | |
enum: | |
- Purina Dog Chow | |
- Purina Chow-Chow Chow | |
scoops: | |
type: integer | |
perDay: | |
type: integer | |
errorModel: | |
type: object | |
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