Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
nilportugues committed Dec 8, 2015
1 parent c7d2488 commit 9c4f31c
Showing 1 changed file with 24 additions and 0 deletions.
24 changes: 24 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,30 @@
- Controller boilerplate to write a fully compiliant **JSON API Server** using your **exisiting Eloquent Models**.
- Works for Laravel 5 and Lumen frameworks.

<br>
- [Installation](#installation)
- [Configuration (Laravel 5 & Lumen)](#configuration-laravel-5--lumen)
- [Configuration for Laravel 5](#configuration-for-laravel-5)
- [Step 1: Add the Service Provider](#step-1-add-the-service-provider)
- [Step 2: Defining routes](#step-2-defining-routes)
- [Step 3: Definition](#step-3-definition)
- [Step 4: Usage](#step-4-usage)
- [Configuration for Lumen](#configuration-for-lumen)
- [Step 1: Add the Service Provider](#step-1-add-the-service-provider-1)
- [Step 2: Defining routes](#step-2-defining-routes-1)
- [Step 3: Definition](#step-3-definitio-1n)
- [Step 4: Usage](#step-4-usage-1)
- [JsonApiController](#jsonapicontroller)
- [Examples: Consuming the API](#examples-consuming-the-api)
- [GET](#get)
- [POST](#post)
- [PUT](#put)
- [PATCH](#patch)
- [DELETE](#delete)
- [GET Query Params: include, fields, sort and page](#get-query-params-include-fields-sort-and-page)
- [POST/PUT/PATCH with Relationships](#postputpatch-with-relationships)
- [Custom Response Headers](#custom-response-headers)


## Installation

Expand Down

0 comments on commit 9c4f31c

Please sign in to comment.