Code Monkey home page Code Monkey logo

json-api-documents's Introduction

! (https://travis-ci.org/pkracer/json-api-documents.svg)

Json Api Documents

This package can be used to format api responses to adhere to the Json Api specification v1.0

Install

Via Composer

$ composer require pkracer/json-api-documents

Requirements

The following versions of PHP are required by this version.

  • PHP 5.5
  • PHP 5.6
  • PHP 7.0-dev
  • HHVM

Documentation

$document = new \Pkracer\JsonApiDocuments\Document();
$document->describe(['version' => '1.0'])
->meta(['count' => '10'])
->links([
'self' => 'http://example.com/articles',
'next' => 'http://example.com/articles?page[offset]=2',
'last' => 'http://example.com/articles?page[offset]=10'
]);

Laravel

$document = new \Pkracer\JsonApiDocuments\Document();
$document->describe(['version' => '1.0'])
$posts = \App\Post::all();
$document->data($posts);

License

The MIT License (MIT). Please see License File for more information.

json-api-documents's People

Contributors

pkracer avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.