Created
June 16, 2019 21:56
-
-
Save mustafashabib/a8facc68c2b74b242adfac3aec94b0a2 to your computer and use it in GitHub Desktop.
petstore with oauth2 spec
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
swagger: "2.0" | |
info: | |
version: 1.0.0 | |
title: Swagger Petstore | |
license: | |
name: MIT | |
host: localhost:8080 | |
basePath: /api | |
schemes: | |
- http | |
consumes: | |
- application/json | |
produces: | |
- application/json | |
securityDefinitions: | |
OAuth2: | |
type: oauth2 | |
flow: accessCode | |
authorizationUrl: https://example.com/oauth/authorize | |
tokenUrl: https://example.com/oauth/token | |
scopes: | |
read: Grants read access | |
write: Grants write access | |
admin: Grants read and write access to administrative information | |
paths: | |
/pets: | |
get: | |
security: | |
- OAuth2: [read, write] | |
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 | |
format: int32 | |
minimum: 1 | |
maximum: 10 | |
responses: | |
"200": | |
description: An paged array of pets | |
headers: | |
x-next: | |
type: string | |
description: A link to the next page of responses | |
schema: | |
$ref: '#/definitions/Pets' | |
default: | |
description: unexpected error | |
schema: | |
$ref: '#/definitions/Error' | |
post: | |
summary: Create a pet | |
operationId: createPets | |
tags: | |
- pets | |
responses: | |
"201": | |
description: Null response | |
default: | |
description: unexpected error | |
schema: | |
$ref: '#/definitions/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 | |
type: string | |
responses: | |
"200": | |
description: Expected response to a valid request | |
schema: | |
$ref: '#/definitions/Pets' | |
default: | |
description: unexpected error | |
schema: | |
$ref: '#/definitions/Error' | |
definitions: | |
Pet: | |
required: | |
- id | |
- name | |
properties: | |
id: | |
type: integer | |
format: int64 | |
name: | |
type: string | |
tag: | |
type: string | |
Pets: | |
type: array | |
items: | |
$ref: '#/definitions/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