FriendsOfCake/crud-json-api

Name: crud-json-api

Owner: Friends Of Cake

Description: CakePHP Crud Listener for building JSON API compliant APIs

Created: 2017-04-27 17:56:19.0

Updated: 2018-05-23 20:49:14.0

Pushed: 2018-05-24 15:41:41.0

Homepage:

Size: 4312

Language: PHP

GitHub Committers

User	Most Recent Commit	# Commits

Other Committers

User	Email	Most Recent Commit	# Commits

README

JSON API Crud Listener for CakePHP

Crud Listener for (rapidly) building CakePHP APIs following the JSON API specification.

Documentation

Documentation found here.

Installation

oser require friendsofcake/crud-json-api

Why use it?

• standardized API data fetching, data posting and (validation) errors
• automated handling of complex associations/relationships
• instant compatibility with JSON API supporting tools like Ember Data
• tons of configurable options to manipulate the generated json

Sample output

"data": {
  "type": "countries",
  "id": "2",
  "attributes": {
    "code": "BE",
    "name": "Belgium"
  },
  "relationships": {
    "currency": {
      "data": {
        "type": "currencies",
        "id": "1"
      },
      "links": {
        "self": "/currencies/1"
      }
    },
    "cultures": {
      "data": [
        {
          "type": "cultures",
          "id": "2"
        },
        {
          "type": "cultures",
          "id": "3"
        }
      ],
      "links": {
        "self": "/cultures?country_id=2"
      }
    }
  },
  "links": {
    "self": "/countries/2"
  }
},
"included": [
  {
    "type": "currencies",
    "id": "1",
    "attributes": {
      "code": "EUR",
      "name": "Euro"
    },
    "links": {
      "self": "/currencies/1"
    }
  },
  {
    "type": "cultures",
    "id": "2",
    "attributes": {
      "code": "nl-BE",
      "name": "Dutch (Belgium)"
    },
    "links": {
      "self": "/cultures/2"
    }
  },
  {
    "type": "cultures",
    "id": "3",
    "attributes": {
      "code": "fr-BE",
      "name": "French (Belgium)"
    },
    "links": {
      "self": "/cultures/3"
    }
  }
]

Contribute

Before submitting a PR make sure:

• PHPUnit and CakePHP Code Sniffer tests pass
• Codecov Code Coverage does not drop