2017 © Pedro Peláez
 

library api-lib

Rcm Api Library

image

rcm/api-lib

Rcm Api Library

  • Wednesday, October 4, 2017
  • by reliv
  • Repository
  • 7 Watchers
  • 0 Stars
  • 3,630 Installations
  • PHP
  • 12 Dependents
  • 0 Suggesters
  • 3 Forks
  • 0 Open issues
  • 57 Versions
  • 1 % Grown

The README.md

Rcm Api Lib

API basic response library making use of Middleware (like Zend Expressive) OR ZF2's MVC framework, (*1)

Makes it easy to quickly create a common API data format., (*2)

Include a JavaScript (Angular.JS) library for the client., (*3)

Several types of common error message types are supported:
  • Array
  • Exception
  • HttpStatusCode
  • InputFilter (Zend)
  • String
  • Custom types can also be injected

EXAMPLE: Middleware (like Zend Expressive)

// From a Middleware that extends Reliv\RcmApiLib\Middleware\AbstractJsonController

    /** EXAMPLE: InputFilter (Zend)  **/
    public function __invoke(
        ServerRequestInterface $request,
        ResponseInterface $response,
        callable $next
    ) {
        $inputFilter = new RcmGoogleAnalyticsFilter();

        $inputFilter->setData($data);

        if (!$inputFilter->isValid()) {
            return $this->getApiResponse(
                [],
                400,
                $inputFilter
            );
        }
    }
Returns something like:
{
  "data": [],
  "messages": [
    {
      "type": "inputFilter",
      "source": "validation",
      "code": "error",
      "value": "Some information was missing or invalid on the form. Please check the form and try again.",
      "primary": true,
      "params": [],
      "key": "inputFilter.validation.error"
    },
    {
      "type": "validatorMessage",
      "source": "my-value",
      "code": "isEmpty",
      "value": "Value is required and can't be empty",
      "primary": null,
      "params": [],
      "key": "validatorMessage.my-value.isEmpty"
    }
  ]
} 

    /** EXAMPLE: General **/
    public function __invoke(
        ServerRequestInterface $request,
        ResponseInterface $response,
        callable $next
    ) {
        return $this->getApiResponse(
            ['my' => 'response'],
            400,
            new ApiMessage(
                'my-type',
                'my-message-value {my-param}',
                'my-source',
                'my-code',
                true,
                ['my-param' => 'my-value']
            )
        );
    }

EXAMPLE: Zend Framework

// From a ZF2 Controller that extends \Reliv\RcmApiLib\Controller\AbstractRestfulJsonController
// @see \Reliv\RcmApiLib\Controller\ExampleRestfulJsonController

    // Add exception message
    $this->addApiMessage(
        new \Exception('Some exception')
    );

    // Add generic message as array
    $this->addApiMessage(
        [
            'key' => 'ArrayError',
            'value' => 'Some {param} Message',
            'primary' => true,
            'type' => 'Array',
            'code' => 'mycode',
            'params' => ['param' => 'array message']
        ]
    );

    // Add generic message as object
    $this->addApiMessage(
        new ApiMessage('MYKEY', 'Some Message')
    );

    // Add HTTP sttus message
    $this->addApiMessage(
        new HttpStatusCodeApiMessage(403)
    );

    // Add inputFilter message
    $inputFilter = new \Zend\InputFilter\InputFilter(); // Use you own inputFilter here
    $this->addApiMessage(
        $inputFilter
    );

    // Return the response
    return $this->getApiResponse(
        null,
        $statusCode = 200,
        $inputFilter,
        true
    );

    // Return the response with your data and no messages
    return $this->getApiResponse(
        ['myThing' => 'someThing'],
    );

Author:

James Jervis jjervis@relivinc.com Copyright (c) 2015, Reliv' International, Inc. https://github.com/reliv/rcm-api-lib, (*4)

The Versions

04/10 2017

dev-master

9999999-dev https://github.com/reliv/rcm-api-lib

Rcm Api Library

  Sources   Download

BSD-3-Clause

The Requires

 

The Development Requires

by James Jervis

api zf2 module expressive rcm

02/10 2017

0.11.2

0.11.2.0 https://github.com/reliv/rcm-api-lib

Rcm Api Library

  Sources   Download

BSD-3-Clause

The Requires

 

The Development Requires

by James Jervis

api zf2 module expressive rcm

27/09 2017

0.11.1

0.11.1.0 https://github.com/reliv/rcm-api-lib

Rcm Api Library

  Sources   Download

BSD-3-Clause

The Requires

 

The Development Requires

by James Jervis

api zf2 module expressive rcm

27/09 2017

0.11.0

0.11.0.0 https://github.com/reliv/rcm-api-lib

Rcm Api Library

  Sources   Download

BSD-3-Clause

The Requires

 

The Development Requires

by James Jervis

api zf2 module expressive rcm

19/09 2017

0.10.3

0.10.3.0 https://github.com/reliv/rcm-api-lib

Rcm Api Library

  Sources   Download

BSD-3-Clause

The Requires

 

The Development Requires

by James Jervis

api zf2 module expressive rcm

21/07 2017

0.10.2

0.10.2.0 https://github.com/reliv/rcm-api-lib

Rcm Api Library

  Sources   Download

BSD-3-Clause

The Requires

 

The Development Requires

by James Jervis

api zf2 module expressive rcm

30/06 2017

0.10.1

0.10.1.0 https://github.com/reliv/rcm-api-lib

Rcm Api Library

  Sources   Download

BSD-3-Clause

The Requires

 

The Development Requires

by James Jervis

api zf2 module expressive rcm

29/06 2017

0.10.0

0.10.0.0 https://github.com/reliv/rcm-api-lib

Rcm Api Library

  Sources   Download

BSD-3-Clause

The Requires

 

The Development Requires

by James Jervis

api zf2 module expressive rcm

12/05 2017

0.9.7

0.9.7.0 https://github.com/reliv/rcm-api-lib

Rcm Api Library

  Sources   Download

BSD-3-Clause

The Requires

 

The Development Requires

by James Jervis

api zf2 module expressive rcm

09/05 2017

0.9.6

0.9.6.0 https://github.com/reliv/rcm-api-lib

Rcm Api Library

  Sources   Download

BSD-3-Clause

The Requires

 

The Development Requires

by James Jervis

api zf2 module expressive rcm

04/05 2017

0.9.5

0.9.5.0 https://github.com/reliv/rcm-api-lib

Rcm Api Library

  Sources   Download

BSD-3-Clause

The Requires

 

The Development Requires

by James Jervis

api zf2 module expressive rcm

03/05 2017

0.9.4

0.9.4.0 https://github.com/reliv/rcm-api-lib

Rcm Api Library

  Sources   Download

BSD-3-Clause

The Requires

 

The Development Requires

by James Jervis

api zf2 module expressive rcm

28/04 2017

0.9.3

0.9.3.0 https://github.com/reliv/rcm-api-lib

Rcm Api Library

  Sources   Download

BSD-3-Clause

The Requires

 

The Development Requires

by James Jervis

api zf2 module expressive rcm

31/03 2017

0.9.2

0.9.2.0 https://github.com/reliv/rcm-api-lib

Rcm Api Library

  Sources   Download

BSD-3-Clause

The Requires

 

The Development Requires

by James Jervis

api zf2 module expressive rcm

31/01 2017

0.9.1

0.9.1.0 https://github.com/reliv/rcm-api-lib

Rcm Api Library

  Sources   Download

BSD-3-Clause

The Requires

 

The Development Requires

by James Jervis

api zf2 module expressive rcm

25/01 2017

0.9.0

0.9.0.0 https://github.com/reliv/rcm-api-lib

Rcm Api Library

  Sources   Download

BSD-3-Clause

The Requires

 

The Development Requires

by James Jervis

api zf2 module expressive rcm

19/12 2016

0.8.3

0.8.3.0 https://github.com/reliv/rcm-api-lib

Rcm Api Library

  Sources   Download

BSD-3-Clause

The Requires

 

The Development Requires

by James Jervis

api zf2 module expressive rcm

02/12 2016

0.8.2

0.8.2.0 https://github.com/reliv/rcm-api-lib

Rcm Api Library

  Sources   Download

BSD-3-Clause

The Requires

 

The Development Requires

by James Jervis

api zf2 module expressive rcm

29/11 2016

0.8.1

0.8.1.0 https://github.com/reliv/rcm-api-lib

Rcm Api Library

  Sources   Download

BSD-3-Clause

The Requires

 

The Development Requires

by James Jervis

api zf2 module expressive rcm

09/11 2016

0.8.0

0.8.0.0 https://github.com/reliv/rcm-api-lib

Rcm Api Library

  Sources   Download

BSD-3-Clause

The Requires

 

The Development Requires

by James Jervis

api zf2 module expressive rcm

08/09 2016

0.7.2

0.7.2.0 https://github.com/reliv/rcm-api-lib

Rcm Api Library

  Sources   Download

BSD-3-Clause

The Requires

 

by James Jervis

api zf2 module rcm

05/08 2016

0.7.0

0.7.0.0 https://github.com/reliv/rcm-api-lib

Rcm Api Library

  Sources   Download

BSD-3-Clause

The Requires

 

by James Jervis

api zf2 module rcm

05/08 2016

0.6.1

0.6.1.0 https://github.com/reliv/rcm-api-lib

Rcm Api Library

  Sources   Download

BSD-3-Clause

The Requires

 

by James Jervis

api zf2 module rcm

04/08 2016

0.6.0

0.6.0.0 https://github.com/reliv/rcm-api-lib

Rcm Api Library

  Sources   Download

BSD-3-Clause

The Requires

 

by James Jervis

api zf2 module rcm

01/07 2016

0.5.9

0.5.9.0 https://github.com/reliv/rcm-api-lib

Rcm Api Library

  Sources   Download

BSD-3-Clause

The Requires

 

by James Jervis

api zf2 module rcm

21/06 2016

0.5.8

0.5.8.0 https://github.com/reliv/rcm-api-lib

Rcm Api Library

  Sources   Download

BSD-3-Clause

The Requires

 

by James Jervis

api zf2 module rcm

31/05 2016

0.5.7

0.5.7.0 https://github.com/reliv/rcm-api-lib

Rcm Api Library

  Sources   Download

BSD-3-Clause

The Requires

 

by James Jervis

api zf2 module rcm

12/05 2016

0.5.6

0.5.6.0 https://github.com/reliv/rcm-api-lib

Rcm Api Library

  Sources   Download

BSD-3-Clause

The Requires

 

by James Jervis

api zf2 module rcm

03/05 2016

0.5.5

0.5.5.0 https://github.com/reliv/rcm-api-lib

Rcm Api Library

  Sources   Download

BSD-3-Clause

The Requires

 

by James Jervis

api zf2 module rcm

03/05 2016

0.5.4

0.5.4.0 https://github.com/reliv/rcm-api-lib

Rcm Api Library

  Sources   Download

BSD-3-Clause

The Requires

 

by James Jervis

api zf2 module rcm

12/04 2016

0.5.3

0.5.3.0 https://github.com/reliv/rcm-api-lib

Rcm Api Library

  Sources   Download

BSD-3-Clause

The Requires

 

by James Jervis

api zf2 module rcm

15/02 2016

0.5.2

0.5.2.0 https://github.com/reliv/rcm-api-lib

Rcm Api Library

  Sources   Download

BSD-3-Clause

The Requires

 

by James Jervis

api zf2 module rcm

03/02 2016

0.5.1

0.5.1.0 https://github.com/reliv/rcm-api-lib

Rcm Api Library

  Sources   Download

BSD-3-Clause

The Requires

 

by James Jervis

api zf2 module rcm

27/01 2016

0.5.0

0.5.0.0 https://github.com/reliv/rcm-api-lib

Rcm Api Library

  Sources   Download

BSD-3-Clause

The Requires

 

by James Jervis

api zf2 module rcm

04/01 2016

0.4.1

0.4.1.0 https://github.com/reliv/rcm-api-lib

Rcm Api Library

  Sources   Download

BSD-3-Clause

The Requires

 

by James Jervis

api zf2 module rcm

31/12 2015

0.4.0

0.4.0.0 https://github.com/reliv/rcm-api-lib

Rcm Api Library

  Sources   Download

BSD-3-Clause

The Requires

 

by James Jervis

api zf2 module rcm

18/12 2015

0.3.7

0.3.7.0 https://github.com/reliv/rcm-api-lib

Rcm Api Library

  Sources   Download

BSD-3-Clause

The Requires

 

by James Jervis

api zf2 module rcm

18/12 2015

0.3.6

0.3.6.0 https://github.com/reliv/rcm-api-lib

Rcm Api Library

  Sources   Download

BSD-3-Clause

The Requires

 

by James Jervis

api zf2 module rcm

18/12 2015

0.3.5

0.3.5.0 https://github.com/reliv/rcm-api-lib

Rcm Api Library

  Sources   Download

BSD-3-Clause

The Requires

 

by James Jervis

api zf2 module rcm

01/12 2015

0.3.4

0.3.4.0 https://github.com/reliv/rcm-api-lib

Rcm Api Library

  Sources   Download

BSD-3-Clause

The Requires

 

by James Jervis

api zf2 module rcm

01/12 2015

0.3.3

0.3.3.0 https://github.com/reliv/rcm-api-lib

Rcm Api Library

  Sources   Download

BSD-3-Clause

The Requires

 

by James Jervis

api zf2 module rcm

17/11 2015

0.3.2

0.3.2.0 https://github.com/reliv/rcm-api-lib

Rcm Api Library

  Sources   Download

BSD-3-Clause

The Requires

 

by James Jervis

api zf2 module rcm

16/11 2015

0.3.1

0.3.1.0 https://github.com/reliv/rcm-api-lib

Rcm Api Library

  Sources   Download

BSD-3-Clause

The Requires

 

by James Jervis

api zf2 module rcm

16/10 2015

0.3.0

0.3.0.0 https://github.com/reliv/rcm-api-lib

Rcm Api Library

  Sources   Download

BSD-3-Clause

The Requires

 

by James Jervis

api zf2 module rcm

02/10 2015

0.1.12

0.1.12.0 https://github.com/reliv/rcm-api-lib

Rcm Api Library

  Sources   Download

BSD-3-Clause

The Requires

 

by James Jervis

api zf2 module rcm

28/09 2015

0.1.11

0.1.11.0 https://github.com/reliv/rcm-api-lib

Rcm Api Library

  Sources   Download

BSD-3-Clause

The Requires

 

by James Jervis

api zf2 module rcm

10/08 2015

0.1.10

0.1.10.0 https://github.com/reliv/rcm-api-lib

Rcm Api Library

  Sources   Download

BSD-3-Clause

The Requires

 

by James Jervis

api zf2 module rcm

07/08 2015

0.1.9

0.1.9.0 https://github.com/reliv/rcm-api-lib

Rcm Api Library

  Sources   Download

BSD-3-Clause

The Requires

 

by James Jervis

api zf2 module rcm

31/07 2015

0.1.8

0.1.8.0 https://github.com/reliv/rcm-api-lib

Rcm Api Library

  Sources   Download

BSD-3-Clause

The Requires

 

by James Jervis

api zf2 module rcm

28/07 2015

0.1.7

0.1.7.0 https://github.com/reliv/rcm-api-lib

Rcm Api Library

  Sources   Download

BSD-3-Clause

The Requires

 

by James Jervis

api zf2 module rcm

27/07 2015

0.1.6

0.1.6.0 https://github.com/reliv/rcm-api-lib

Rcm Api Library

  Sources   Download

BSD-3-Clause

The Requires

 

by James Jervis

api zf2 module rcm

21/07 2015

0.1.5

0.1.5.0 https://github.com/reliv/rcm-api-lib

Rcm Api Library

  Sources   Download

BSD-3-Clause

The Requires

 

by James Jervis

api zf2 module rcm

20/07 2015

0.1.4

0.1.4.0 https://github.com/reliv/rcm-api-lib

Rcm Api Library

  Sources   Download

BSD-3-Clause

The Requires

 

by James Jervis

api zf2 module rcm

10/07 2015

0.1.3

0.1.3.0 https://github.com/reliv/rcm-api-lib

Rcm Api Library

  Sources   Download

BSD-3-Clause

The Requires

 

by James Jervis

api zf2 module rcm

08/07 2015

0.1.2

0.1.2.0 https://github.com/reliv/rcm-api-lib

Rcm Api Library

  Sources   Download

BSD-3-Clause

The Requires

 

by James Jervis

api zf2 module rcm

08/07 2015

0.1.1

0.1.1.0 https://github.com/reliv/rcm-api-lib

Rcm Api Library

  Sources   Download

BSD-3-Clause

The Requires

 

by James Jervis

api zf2 module rcm

07/07 2015

0.1.0

0.1.0.0 https://github.com/reliv/rcm-api-lib

Rcm Api Library

  Sources   Download

BSD-3-Clause

The Requires

 

by James Jervis

api zf2 module rcm