Created
January 22, 2016 16:26
-
-
Save sebastianhenneberg/0d8591d06039787a7d74 to your computer and use it in GitHub Desktop.
Example API with RAML Step 6
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
# document root and types | |
/users: | |
# get operation | |
post: | |
description: Create new user. | |
body: | |
type: UserBase | |
responses: | |
201: | |
description: New user created successful. | |
400: | |
description: Required properties missing or validation issues. | |
body: | |
type: Error | |
/{userId}: | |
uriParameters: | |
userId: integer | |
put: | |
description: Update user. | |
body: | |
type: UserBase | |
responses: | |
200: | |
description: User updated successful. | |
body: | |
type: User | |
400: | |
description: Required properties missing or validation issues. | |
body: | |
type: Error | |
404: | |
description: Unkown user. | |
body: | |
type: Error |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment