Created
July 26, 2014 02:46
-
-
Save earth2marsh/6a2525c12fba35734d18 to your computer and use it in GitHub Desktop.
Petstore Samples
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 | |
host: petstore.swagger.wordnik.com | |
basePath: /v1 | |
license: | |
name: MIT | |
schemes: | |
- http | |
consumes: | |
- application/json | |
produces: | |
- application/json | |
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 | |
type: integer | |
responses: | |
200: | |
description: An paged array of pets | |
headers: | |
- x-next: | |
type: string | |
description: A link to the next page of responses | |
schema: | |
$ref: Pets | |
default: | |
description: unexpected error | |
schema: | |
$ref: Error | |
post: | |
summary: Create a pet | |
operationId: createPets | |
tags: | |
- pets | |
responses: | |
201: | |
description: Null response | |
default: | |
description: unexpected error | |
schema: | |
$ref: Error | |
/pets/{petId}: | |
get: | |
summary: Info for a specific pet | |
operationId: showPetById | |
tags: | |
- pets | |
parameters: | |
- name: petId | |
in: path | |
description: The id of the pet to retrieve | |
type: string | |
responses: | |
200: | |
description: Expected response to a valid request | |
schema: | |
$ref: Pets | |
default: | |
description: unexpected error | |
schema: | |
$ref: Error | |
schemas: | |
Pet: | |
required: | |
- id | |
- name | |
properties: | |
id: | |
type: integer | |
format: int64 | |
name: | |
type: string | |
tag: | |
type: string | |
Pets: | |
type: array | |
items: | |
$ref: 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