Skip to content
This repository has been archived by the owner on Nov 9, 2017. It is now read-only.

Latest commit

 

History

History
90 lines (53 loc) · 3.59 KB

readme.md

File metadata and controls

90 lines (53 loc) · 3.59 KB
Raw

Laracon 2013 Demo API

See the presentation slides on Speaker Deck or the video on YouTube.

Setup Instructions

Please note: by default this API requires that you have APC installed for rate limiting. You can change the driver if desired in app/config/cache.php.

  1. Make sure you have Composer installed. I recommend installing it globally.
  2. Clone or download this repository.
  3. In a terminal, cd into this project's directory and run composer install.
  4. Create a new MySQL database.
  5. Update the mysql connection options in app/config/database.php.
  6. Run php artisan migrate in the terminal.
  7. Run php artisan db:seed in the terminal.
  8. Start hitting the API in whatever tool you choose. Postman is a nice Chrome extension, and HTTPie is a good command line option.

API Documentation

Authentication

The API uses Basic HTTP authentication for all requests. You must pass a valid API key as a username, and the password can literally be anything.

If you were going to connect via cURL, you would do this:

curl -u "youruserapikeygoeshere:whatever" http://localapidomain.dev/v1/lists

Note that we sent whatever as the password. This can be anything… it doesn't matter. However, since authentication is based on the API key only, you shouldn't share it with anyone.

Response Formats

All responses are in JSON format.

Response Codes

  • 200: The request was successful.
  • 201: The resource was successfully created.
  • 204: The request was successful, but we did not send any content back.
  • 400: The request failed due to an application error, such as a validation error.
  • 401: An API key was either not sent or invalid.
  • 403: The resource does not belong to the authenticated user and is forbidden.
  • 404: The resource was not found.
  • 500: A server error occurred.

API Endpoints

GET /v1/lists

Retrieve an array of the authenticated user's tasklists.

POST /v1/lists

Create a new tasklist. Returns status code 201 on success. Accepts the following parameters:

  • name – The name of the tasklist.

GET /v1/lists/{id}

Retrieve the tasklist with the given ID.

PUT /v1/lists/{id}

Update the tasklist with the given ID. Accepts the same parameters as POST /v1/lists.

DELETE /v1/lists/{id}

Delete the tasklist (and all associated tasks) with the given ID. Returns status code 204 on success.

GET /v1/lists/{id}/tasks

Retrieve tasks for the tasklist with the given ID.

POST /v1/lists/{id}/tasks

Create a new task for the tasklist with the given ID. Returns status code 201 on success. Accepts the following parameters:

  • description – The description of the task.
  • completed – Whether or not the task is completed. A value of yes, y, 1, true, or t will set the task as completed. Anything else will set the task as not completed.

GET /v1/lists/{id}/tasks/{taskid}

Retrieve the task with the given ID.

PUT /v1/lists/{id}/tasks/{taskid}

Update the task with the given ID. Accepts the same parameters as POST /v1/lists/{id}/tasks.

DELETE /v1/lists/{id}/tasks/{taskid}

Delete the task with the given ID. Returns status code 204 on success.