From 08698dbaf5f675d5d9eaf3f25f57fb01d0582e3e Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Linus=20Unneb=C3=A4ck?= Date: Tue, 26 May 2015 09:18:06 +0200 Subject: [PATCH] example: named endpoints --- examples/12. Advanced Action.md | 1 + examples/13. Named Endpoints.md | 41 +++++++++++++++++++++++++++++++++ 2 files changed, 42 insertions(+) create mode 100644 examples/13. Named Endpoints.md diff --git a/examples/12. Advanced Action.md b/examples/12. Advanced Action.md index 2ece9d8..06b4594 100644 --- a/examples/12. Advanced Action.md +++ b/examples/12. Advanced Action.md @@ -6,6 +6,7 @@ A resource action is – in fact – a state transition. This API example demons ## API Blueprint + [Previous: Resource Model](11.%20Resource%20Model.md) + [This: Raw API Blueprint](https://raw.github.com/apiaryio/api-blueprint/master/examples/12.%20Advanced%20Action.md) ++ [Next: Named Endpoints](13.%20Named%20Endpoints.md) # Tasks [/tasks/tasks{?status,priority}] diff --git a/examples/13. Named Endpoints.md b/examples/13. Named Endpoints.md new file mode 100644 index 0000000..1e0154b --- /dev/null +++ b/examples/13. Named Endpoints.md @@ -0,0 +1,41 @@ +FORMAT: 1A + +# Named Endpoints API +This API example demonstrates how to define a standalone endpoint with an identifier. + +## API Blueprint ++ [Previous: Advanced Action](12.%20Advanced%20Action.md) ++ [This: Raw API Blueprint](https://raw.github.com/apiaryio/api-blueprint/master/examples/13.%20Named%20Endpoints.md) + +# Group Quick start + +## Create user [POST /users] + +The first thing we need to do is to add a user that we can later log in as. Do +this by sending a POST request with the relevant details. + ++ Request + + Headers + Content-Type: application/json + + Body + { "username": "Linus", "password": "test" } + ++ Response 201 + + Headers + Location: /user/1337 + +## Log in as the user [POST /session] + +We can now log in as the user we created. This is accomplished by creating a new +session with the relevant login details. + ++ Request + + Headers + Content-Type: application/json + + Body + { "username": "Linus", "password": "test" } + ++ Response 201 + + Headers + X-Token: djksaldjaklsj894ut93 + Location: /session/8493248