https://github.com/cloudcreativity/demo-laravel-json-api

Demo of JSON API integration with a Laravel Application
https://github.com/cloudcreativity/demo-laravel-json-api

json-api laravel php

Last synced: 18 days ago
JSON representation

Demo of JSON API integration with a Laravel Application

• Host: GitHub
• URL: https://github.com/cloudcreativity/demo-laravel-json-api
• Owner: cloudcreativity
• Created: 2016-05-30T13:08:14.000Z (over 8 years ago)
• Default Branch: 5.6
• Last Pushed: 2021-05-09T23:12:53.000Z (over 3 years ago)
• Last Synced: 2023-03-02T22:22:33.706Z (almost 2 years ago)
• Topics: json-api, laravel, php
• Language: PHP
• Size: 1.74 MB
• Stars: 80
• Watchers: 5
• Forks: 25
• Open Issues: 8
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Laravel JSON API Demo

This application demonstrates how to use the 

[cloudcreativity/laravel-json-api](https://github.com/cloudcreativity/laravel-json-api)

package to create a [JSON API](http://jsonapi.org) compliant API. This is demonstrated using Eloquent models as

the domain records that are serialized in the API, but the package is not Eloquent specific.

## Setup

The application uses [Homestead](https://laravel.com/docs/homestead), so you'll need Vagrant installed on your

local machine.

Once you've cloned this repository, change into the project folder then:

``` bash

composer install

cp .env.example .env

php vendor/bin/homestead make

vagrant up

```

> Remember you'll need to add an entry for `homestead.app` in your `/etc/hosts` file.

Once it is up and running, go to the following address in your browser to see the JSON endpoints:

```

http://homestead.app/api/v1/posts

```

To access the web interface:

```

http://homestead.app

```

> If you use the Vagrant hosts updater plugin, the hostname may be `demo-laravel-json-api` or similar. 

## Authentication

Any write requests require an authenticated user. We've installed 

[Laravel Passport](https://laravel.com/docs/passport) for API authentication. You will need to use

[Personal Access Tokens](https://laravel.com/docs/passport#personal-access-tokens) and the Vagrant provisioning

runs the Passport installation command.

To create a token, go to the web interface and login (the username and password fields are completed with

credentials that will sign you in successfully). You'll then see the Passport Person Access Token component

which you can use to issue tokens.

Once you have a token, send a request as follows, replacing the `` with your token.

```http

POST http://homestead.app/api/v1/posts

Accept: application/vnd.api+json

Content-Type: application/vnd.api+json

Authorization: Bearer 

{

    "data": {

        "type": "posts",

        "attributes": {

            "slug": "hello-world",

            "title": "Hello World",

            "content": "..."

        }

    }

}

```

## Eloquent vs Not-Eloquent

This package can handle both Eloquent and non-Eloquent records. You get a lot more functionality out of the box if

you are using Eloquent, but it's possible to integrate non-Eloquent records as needed.

This demo includes the following JSON-API resources:

| Resource | Record | Eloquent? |

| --- | --- | --- |

| comments | App\Comment | Yes |

| posts | App\Post | Yes |

| sites | App\Site | No |

| tags | App\Tag | Yes |

| users | App\User | Yes |

## Tests

We're big on testing, and the `cloudcreativity/laravel-json-api` package comes with test helpers to make integration 

testing a JSON API a breeze. You can see this in action in the `tests/Integration` folder, where there's a test case

for the `posts` resource.

To run the tests:

```bash

vendor/bin/phpunit

```