1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22
|
swagger: '2.0'
info:
version: 1.0.9-abcd
title: 'Swagger Sample API'
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: 'wordnik api team', url: 'http://developer.wordnik.com'}
license: {name: 'Creative Commons 4.0 International', url: 'http://creativecommons.org/licenses/by/4.0/'}
basePath: /v1
schemes:
- http
- https
consumes:
- application/json
produces:
- application/json
- application/xml
paths:
'/pets/{id}': {parameters: [{name: id, in: path, description: 'ID of pet to use', required: true, type: array, items: {type: string}, collectionFormat: csv}], get: {description: 'Returns pets based on ID', summary: 'Find pets by ID', operationId: getPetsById, produces: [application/json, text/html], responses: {'200': {description: 'pet response', schema: {type: array, items: {$ref: Pet}}}, default: {description: 'error payload', schema: {$ref: ErrorModel}}}}}
definitions:
Pet: {required: [name], properties: {name: {type: string}, tag: {type: string}}}
ErrorModel: {required: [code, message], properties: {code: {type: integer, format: int32}, message: {type: string}}}
|