| 123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233 |
- {
- "swagger": "2.0",
- "info": {
- "version": "1.0.0",
- "title": "Swagger Petstore",
- "description": "A sample API that uses a petstore as an example to demonstrate features in the swagger-2.0 specification",
- "termsOfService": "http://swagger.io/terms/",
- "contact": {
- "name": "Swagger API Team",
- "email": "apiteam@swagger.io",
- "url": "http://swagger.io"
- },
- "license": {
- "name": "MIT",
- "url": "http://github.com/gruntjs/grunt/blob/master/LICENSE-MIT"
- }
- },
- "externalDocs": {
- "description": "find more info here",
- "url": "https://swagger.io/about"
- },
- "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",
- "externalDocs": {
- "description": "find more info here",
- "url": "https://swagger.io/about"
- },
- "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": {
- "$ref": "#/definitions/NewPet"
- }
- }
- ],
- "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",
- "allOf": [
- {
- "$ref": "#/definitions/NewPet"
- },
- {
- "required": [
- "id"
- ],
- "properties": {
- "id": {
- "type": "integer",
- "format": "int64"
- }
- }
- }
- ]
- },
- "NewPet": {
- "type": "object",
- "required": [
- "name"
- ],
- "properties": {
- "name": {
- "type": "string"
- },
- "tag": {
- "type": "string"
- }
- }
- },
- "ErrorModel": {
- "type": "object",
- "required": [
- "code",
- "message"
- ],
- "properties": {
- "code": {
- "type": "integer",
- "format": "int32"
- },
- "message": {
- "type": "string"
- }
- }
- }
- }
- }
|