Created
September 19, 2013 14:42
-
-
Save rasmusbergpalm/6624553 to your computer and use it in GitHub Desktop.
swagger json 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": "/user", | |
"produces": [ | |
"application/json" | |
], | |
"apis": [ | |
{ | |
"path": "/user/{username}", | |
"operations": [ | |
{ | |
"method": "GET", | |
"summary": "Get user by user name", | |
"notes": "", | |
"type": "User", | |
"nickname": "getUserByName", | |
"parameters": [ | |
{ | |
"name": "username", | |
"description": "The name that needs to be fetched. Use user1 for testing.", | |
"required": true, | |
"type": "string", | |
"paramType": "path" | |
} | |
], | |
"responseMessages": [ | |
{ | |
"code": 400, | |
"message": "Invalid username supplied" | |
}, | |
{ | |
"code": 404, | |
"message": "User not found" | |
} | |
] | |
} | |
] | |
}, | |
{ | |
"path": "/user/login", | |
"operations": [ | |
{ | |
"method": "GET", | |
"summary": "Logs user into the system", | |
"notes": "", | |
"type": "string", | |
"nickname": "loginUser", | |
"parameters": [ | |
{ | |
"name": "username", | |
"description": "The user name for login", | |
"required": true, | |
"type": "string", | |
"paramType": "query" | |
}, | |
{ | |
"name": "password", | |
"description": "The password for login in clear text", | |
"required": true, | |
"type": "string", | |
"paramType": "query" | |
} | |
], | |
"responseMessages": [ | |
{ | |
"code": 400, | |
"message": "Invalid username and password combination" | |
} | |
] | |
} | |
] | |
}, | |
{ | |
"path": "/user/logout", | |
"operations": [ | |
{ | |
"method": "GET", | |
"summary": "Logs out current logged in user session", | |
"notes": "", | |
"type": "void", | |
"nickname": "logoutUser", | |
"parameters": [] | |
} | |
] | |
} | |
], | |
"models": { | |
"User": { | |
"id": "User", | |
"properties": { | |
"id": { | |
"type": "integer", | |
"format": "int64", | |
"description": "Unique identifier for the user" | |
}, | |
"username": { | |
"type": "string", | |
"description": "Unique username" | |
}, | |
"firstName": { | |
"type": "string", | |
"description": "First name of the user" | |
}, | |
"lastName": { | |
"type": "string", | |
"description": "Last name of the user" | |
}, | |
"email": { | |
"type": "string", | |
"description": "Email address of the user" | |
}, | |
"password": { | |
"type": "string", | |
"description": "Password name of the user" | |
}, | |
"phone": { | |
"type": "string", | |
"description": "Phone number of the user" | |
}, | |
"userStatus": { | |
"type": "integer", | |
"format": "int32", | |
"description": "User Status", | |
"enum": [ | |
"1-registered", | |
"2-active", | |
"3-closed" | |
] | |
} | |
} | |
} | |
} | |
} |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment