Last active
March 6, 2019 05:14
-
-
Save sio4/f86b4d0459372b1143fdfa9d93a32ce4 to your computer and use it in GitHub Desktop.
Swagger 1.2 example
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
{ | |
"apiVersion": "1.0.0", | |
"swaggerVersion": "1.2", | |
"basePath": "http://petstore.swagger.wordnik.com/api", | |
"resourcePath": "/store", | |
"produces": [ | |
"application/json" | |
], | |
"authorizations": {}, | |
"apis": [ | |
{ | |
"path": "/store/order/{orderId}", | |
"operations": [ | |
{ | |
"method": "GET", | |
"summary": "Find purchase order by ID", | |
"notes": "For valid response try integer IDs with value <= 5. Anything above 5 or nonintegers will generate API errors", | |
"type": "Order", | |
"nickname": "getOrderById", | |
"authorizations": {}, | |
"parameters": [ | |
{ | |
"name": "orderId", | |
"description": "ID of pet that needs to be fetched", | |
"required": true, | |
"type": "string", | |
"paramType": "path" | |
} | |
], | |
"responseMessages": [ | |
{ | |
"code": 400, | |
"message": "Invalid ID supplied" | |
}, | |
{ | |
"code": 404, | |
"message": "Order not found" | |
} | |
] | |
}, | |
{ | |
"method": "DELETE", | |
"summary": "Delete purchase order by ID", | |
"notes": "For valid response try integer IDs with value < 1000. Anything above 1000 or nonintegers will generate API errors", | |
"type": "void", | |
"nickname": "deleteOrder", | |
"authorizations": { | |
"oauth2": [ | |
{ | |
"scope": "test:anything", | |
"description": "anything" | |
} | |
] | |
}, | |
"parameters": [ | |
{ | |
"name": "orderId", | |
"description": "ID of the order that needs to be deleted", | |
"required": true, | |
"type": "string", | |
"paramType": "path" | |
} | |
], | |
"responseMessages": [ | |
{ | |
"code": 400, | |
"message": "Invalid ID supplied" | |
}, | |
{ | |
"code": 404, | |
"message": "Order not found" | |
} | |
] | |
} | |
] | |
}, | |
{ | |
"path": "/store/order", | |
"operations": [ | |
{ | |
"method": "POST", | |
"summary": "Place an order for a pet", | |
"notes": "", | |
"type": "void", | |
"nickname": "placeOrder", | |
"authorizations": { | |
"oauth2": [ | |
{ | |
"scope": "test:anything", | |
"description": "anything" | |
} | |
] | |
}, | |
"parameters": [ | |
{ | |
"name": "body", | |
"description": "order placed for purchasing the pet", | |
"required": true, | |
"type": "Order", | |
"paramType": "body" | |
} | |
], | |
"responseMessages": [ | |
{ | |
"code": 400, | |
"message": "Invalid order" | |
} | |
] | |
} | |
] | |
} | |
], | |
"models": { | |
"Order": { | |
"id": "Order", | |
"properties": { | |
"id": { | |
"type": "integer", | |
"format": "int64" | |
}, | |
"petId": { | |
"type": "integer", | |
"format": "int64" | |
}, | |
"quantity": { | |
"type": "integer", | |
"format": "int32" | |
}, | |
"status": { | |
"type": "string", | |
"description": "Order Status", | |
"enum": [ | |
"placed", | |
"approved", | |
"delivered" | |
] | |
}, | |
"shipDate": { | |
"type": "string", | |
"format": "date-time" | |
} | |
} | |
} | |
} | |
} |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment