2017 © Pedro Peláez
 

library charon

Charon is a framework for building self documented RESTfull API's.

image

catlabinteractive/charon

Charon is a framework for building self documented RESTfull API's.

  • Sunday, July 22, 2018
  • by catlab
  • Repository
  • 1 Watchers
  • 0 Stars
  • 670 Installations
  • PHP
  • 3 Dependents
  • 0 Suggesters
  • 0 Forks
  • 0 Open issues
  • 86 Versions
  • 23 % Grown

The README.md

Charon

Build Status, (*1)

Fractal on steroids., (*2)

What?

Charon is a PHP framework for building self documented RESTful API's., (*3)

Please visit our website for more information., (*4)

Getting started

While Charon can be used with any framework, I have created a laravel skeleton project to get you started fast., (*5)

Installation

composer create-project catlabinteractive/laravel-charon api, (*6)

Configuration

Please follow the instructions on https://github.com/CatLabInteractive/laravel-charon-template, (*7)

Why?

When building a RESTful API there are a few things that keep coming back: * Entity to resource transformation * API description * Resource field filtering * Relationship and expanding these relationships * Filtering * Sorting * Pagination, (*8)

Charon tries to take some of this work away by providing a framework that takes care of most of these features. * Instead of transformers, write definitions * Filter and sort based on these definitions * Allow clients to choose fields that should be returned * Expand relationships in a single request * Handle all pagination in one single middleware, (*9)

Documentation

By default, Charon generates Swagger 2.0 documentation. Other documentors can be implemented by implementing the interface., (*10)

Frameworks

Charon works very well with Laravel, but the library is built so that it can be incorporated in other frameworks., (*11)

An ORM is not required, but makes implementing certain functionality (like pagination and filtering) a lot easier., (*12)

Context options

For both fields and expand parameters: add a * to repeat the field (for recursive models)., (*13)

The Versions

22/07 2018

dev-master

9999999-dev

Charon is a framework for building self documented RESTfull API's.

  Sources   Download

MIT

The Requires

 

The Development Requires

22/07 2018

v1.1.9

1.1.9.0

Charon is a framework for building self documented RESTfull API's.

  Sources   Download

MIT

The Requires

 

The Development Requires

18/07 2018

v1.1.8

1.1.8.0

Charon is a framework for building self documented RESTfull API's.

  Sources   Download

MIT

The Requires

 

The Development Requires

18/07 2018

v1.1.7

1.1.7.0

Charon is a framework for building self documented RESTfull API's.

  Sources   Download

MIT

The Requires

 

The Development Requires

18/07 2018

dev-1.0-undefined-values

dev-1.0-undefined-values

Charon is a framework for building self documented RESTfull API's.

  Sources   Download

MIT

The Requires

 

The Development Requires

16/07 2018

v1.1.6

1.1.6.0

Charon is a framework for building self documented RESTfull API's.

  Sources   Download

MIT

The Requires

 

The Development Requires

09/07 2018

v1.1.5

1.1.5.0

Charon is a framework for building self documented RESTfull API's.

  Sources   Download

MIT

The Requires

 

The Development Requires

09/07 2018

v1.1.4

1.1.4.0

Charon is a framework for building self documented RESTfull API's.

  Sources   Download

MIT

The Requires

 

The Development Requires

09/07 2018

v1.0.17

1.0.17.0

Charon is a framework for building self documented RESTfull API's.

  Sources   Download

MIT

The Requires

 

The Development Requires

01/05 2018

1.0.x-dev

1.0.9999999.9999999-dev

Charon is a framework for building self documented RESTfull API's.

  Sources   Download

MIT

The Requires

 

The Development Requires

01/05 2018

v1.0.16

1.0.16.0

Charon is a framework for building self documented RESTfull API's.

  Sources   Download

MIT

The Requires

 

The Development Requires

30/04 2018

v1.0.15

1.0.15.0

Charon is a framework for building self documented RESTfull API's.

  Sources   Download

MIT

The Requires

 

The Development Requires

25/04 2018

v1.1.3

1.1.3.0

Charon is a framework for building self documented RESTfull API's.

  Sources   Download

MIT

The Requires

 

The Development Requires

13/04 2018

v1.1.2

1.1.2.0

Charon is a framework for building self documented RESTfull API's.

  Sources   Download

MIT

The Requires

 

The Development Requires

13/04 2018

v1.1.1

1.1.1.0

Charon is a framework for building self documented RESTfull API's.

  Sources   Download

MIT

The Requires

 

The Development Requires

13/04 2018

v1.1.0

1.1.0.0

Charon is a framework for building self documented RESTfull API's.

  Sources   Download

MIT

The Requires

 

The Development Requires

11/04 2018

v1.0.14

1.0.14.0

Charon is a framework for building self documented RESTfull API's.

  Sources   Download

MIT

The Requires

 

The Development Requires

09/04 2018

v1.0.13

1.0.13.0

Charon is a framework for building self documented RESTfull API's.

  Sources   Download

MIT

The Requires

 

The Development Requires

28/02 2018

v1.0.12

1.0.12.0

Charon is a framework for building self documented RESTfull API's.

  Sources   Download

MIT

The Requires

 

The Development Requires

26/02 2018

v1.0.11

1.0.11.0

Charon is a framework for building self documented RESTfull API's.

  Sources   Download

MIT

The Requires

 

The Development Requires

04/02 2018

v1.0.10

1.0.10.0

Charon is a framework for building self documented RESTfull API's.

  Sources   Download

MIT

The Requires

 

The Development Requires

27/10 2017

v1.0.9

1.0.9.0

Charon is a framework for building self documented RESTfull API's.

  Sources   Download

MIT

The Requires

 

The Development Requires

17/08 2017

dev-develop

dev-develop

Charon is a framework for building self documented RESTfull API's.

  Sources   Download

MIT

The Requires

 

The Development Requires

15/06 2017

v1.0.8

1.0.8.0

Charon is a framework for building self documented RESTfull API's.

  Sources   Download

MIT

The Requires

 

The Development Requires

15/06 2017

v1.0.7

1.0.7.0

Charon is a framework for building self documented RESTfull API's.

  Sources   Download

MIT

The Requires

 

The Development Requires

14/06 2017

v1.0.6

1.0.6.0

Charon is a framework for building self documented RESTfull API's.

  Sources   Download

MIT

The Requires

 

The Development Requires

14/06 2017

v1.0.5

1.0.5.0

Charon is a framework for building self documented RESTfull API's.

  Sources   Download

MIT

The Requires

 

The Development Requires

18/05 2017

v1.0.4

1.0.4.0

Charon is a framework for building self documented RESTfull API's.

  Sources   Download

MIT

The Requires

 

The Development Requires

18/05 2017

v1.0.3

1.0.3.0

Charon is a framework for building self documented RESTfull API's.

  Sources   Download

MIT

The Requires

 

The Development Requires

18/05 2017

v1.0.2

1.0.2.0

Charon is a framework for building self documented RESTfull API's.

  Sources   Download

MIT

The Requires

 

The Development Requires

18/05 2017

v1.0.1

1.0.1.0

Charon is a framework for building self documented RESTfull API's.

  Sources   Download

MIT

The Requires

 

The Development Requires

03/05 2017

v1.0.0

1.0.0.0

Charon is a framework for building self documented RESTfull API's.

  Sources   Download

MIT

The Requires

 

The Development Requires

03/05 2017

v0.1.66

0.1.66.0

Charon is a framework for building self documented RESTfull API's.

  Sources   Download

MIT

The Requires

 

The Development Requires

03/05 2017

v0.1.65

0.1.65.0

Charon is a framework for building self documented RESTfull API's.

  Sources   Download

MIT

The Requires

 

The Development Requires

03/05 2017

v0.1.64

0.1.64.0

Charon is a framework for building self documented RESTfull API's.

  Sources   Download

MIT

The Requires

 

The Development Requires

03/05 2017

v0.1.63

0.1.63.0

Charon is a framework for building self documented RESTfull API's.

  Sources   Download

MIT

The Requires

 

The Development Requires

03/05 2017

v0.1.62

0.1.62.0

Charon is a framework for building self documented RESTfull API's.

  Sources   Download

MIT

The Requires

 

The Development Requires

03/05 2017

v0.1.60

0.1.60.0

Charon is a framework for building self documented RESTfull API's.

  Sources   Download

MIT

The Requires

 

The Development Requires

03/05 2017

v0.1.59

0.1.59.0

Charon is a framework for building self documented RESTfull API's.

  Sources   Download

MIT

The Requires

 

The Development Requires

03/05 2017

v0.1.58

0.1.58.0

Charon is a framework for building self documented RESTfull API's.

  Sources   Download

MIT

The Requires

 

The Development Requires

03/05 2017

v0.1.61

0.1.61.0

Charon is a framework for building self documented RESTfull API's.

  Sources   Download

MIT

The Requires

 

The Development Requires

03/05 2017

v0.1.57

0.1.57.0

Charon is a framework for building self documented RESTfull API's.

  Sources   Download

MIT

The Requires

 

The Development Requires

21/04 2017

v0.1.56

0.1.56.0

Charon is a framework for building self documented RESTfull API's.

  Sources   Download

MIT

The Requires

 

The Development Requires

28/03 2017

v0.1.55

0.1.55.0

Charon is a framework for building self documented RESTfull API's.

  Sources   Download

MIT

The Requires

 

The Development Requires

27/03 2017

v0.1.54

0.1.54.0

Charon is a framework for building self documented RESTfull API's.

  Sources   Download

MIT

The Requires

 

The Development Requires

27/03 2017

v0.1.53

0.1.53.0

Charon is a framework for building self documented RESTfull API's.

  Sources   Download

MIT

The Requires

 

The Development Requires

24/02 2017

v0.1.52

0.1.52.0

Charon is a framework for building self documented RESTfull API's.

  Sources   Download

MIT

The Requires

 

The Development Requires

23/02 2017

v0.1.51

0.1.51.0

Charon is a framework for building self documented RESTfull API's.

  Sources   Download

MIT

The Requires

 

The Development Requires

23/02 2017

v0.1.50

0.1.50.0

Charon is a framework for building self documented RESTfull API's.

  Sources   Download

MIT

The Requires

 

The Development Requires

17/02 2017

v0.1.49

0.1.49.0

Charon is a framework for building self documented RESTfull API's.

  Sources   Download

MIT

The Requires

 

The Development Requires

15/02 2017

v0.1.48

0.1.48.0

Charon is a framework for building self documented RESTfull API's.

  Sources   Download

MIT

The Requires

 

The Development Requires

15/02 2017

dev-support-multiple-input-parsers

dev-support-multiple-input-parsers

Charon is a framework for building self documented RESTfull API's.

  Sources   Download

MIT

The Requires

 

The Development Requires

15/02 2017

v0.1.47

0.1.47.0

Charon is a framework for building self documented RESTfull API's.

  Sources   Download

MIT

The Requires

 

The Development Requires

13/02 2017

v0.1.46

0.1.46.0

Charon is a framework for building self documented RESTfull API's.

  Sources   Download

MIT

The Requires

 

The Development Requires

13/02 2017

v0.1.44

0.1.44.0

Charon is a framework for building self documented RESTfull API's.

  Sources   Download

MIT

The Requires

 

The Development Requires

13/02 2017

v0.1.45

0.1.45.0

Charon is a framework for building self documented RESTfull API's.

  Sources   Download

MIT

The Requires

 

The Development Requires

13/02 2017

v0.1.43

0.1.43.0

Charon is a framework for building self documented RESTfull API's.

  Sources   Download

MIT

The Requires

 

The Development Requires

10/02 2017

v0.1.42

0.1.42.0

Charon is a framework for building self documented RESTfull API's.

  Sources   Download

MIT

The Requires

 

The Development Requires

03/02 2017

v0.1.41

0.1.41.0

Charon is a framework for building self documented RESTfull API's.

  Sources   Download

MIT

The Requires

 

The Development Requires

02/02 2017

v0.1.40

0.1.40.0

Charon is a framework for building self documented RESTfull API's.

  Sources   Download

MIT

The Requires

 

The Development Requires

02/02 2017

v0.1.39

0.1.39.0

Charon is a framework for building self documented RESTfull API's.

  Sources   Download

MIT

The Requires

 

The Development Requires

01/02 2017

v0.1.38

0.1.38.0

Charon is a framework for building self documented RESTfull API's.

  Sources   Download

MIT

The Requires

 

The Development Requires

30/01 2017

v0.1.37

0.1.37.0

Charon is a framework for building self documented RESTfull API's.

  Sources   Download

MIT

The Requires

 

The Development Requires

18/01 2017

v0.1.36

0.1.36.0

Charon is a framework for building self documented RESTfull API's.

  Sources   Download

MIT

The Requires

 

The Development Requires

18/01 2017

v0.1.35

0.1.35.0

Charon is a framework for building self documented RESTfull API's.

  Sources   Download

MIT

The Requires

 

The Development Requires

10/01 2017

v0.1.34

0.1.34.0

Charon is a framework for building self documented RESTfull API's.

  Sources   Download

MIT

The Requires

 

The Development Requires

28/12 2016

v0.1.33

0.1.33.0

Charon is a framework for building self documented RESTfull API's.

  Sources   Download

MIT

The Requires

 

The Development Requires

08/12 2016

v0.1.32

0.1.32.0

Charon is a framework for building self documented RESTfull API's.

  Sources   Download

MIT

The Requires

 

The Development Requires

05/12 2016

v0.1.31

0.1.31.0

Charon is a framework for building self documented RESTfull API's.

  Sources   Download

MIT

The Requires

 

The Development Requires

05/12 2016

v0.1.30

0.1.30.0

Charon is a framework for building self documented RESTfull API's.

  Sources   Download

MIT

The Requires

 

The Development Requires

07/10 2016

v0.1.29

0.1.29.0

Charon is a framework for building self documented RESTfull API's.

  Sources   Download

MIT

The Requires

 

The Development Requires

29/09 2016

v0.1.28

0.1.28.0

Charon is a framework for building self documented RESTfull API's.

  Sources   Download

MIT

The Requires

 

The Development Requires

29/09 2016

v0.1.27

0.1.27.0

Charon is a framework for building self documented RESTfull API's.

  Sources   Download

MIT

The Requires

 

The Development Requires

29/09 2016

v0.1.26

0.1.26.0

Charon is a framework for building self documented RESTfull API's.

  Sources   Download

MIT

The Requires

 

The Development Requires

27/09 2016

v0.1.25

0.1.25.0

Charon is a framework for building self documented RESTfull API's.

  Sources   Download

MIT

The Requires

 

The Development Requires

06/09 2016

v0.1.24

0.1.24.0

Charon is a framework for building self documented RESTfull API's.

  Sources   Download

MIT

The Requires

 

The Development Requires

06/09 2016

v0.1.23

0.1.23.0

Charon is a framework for building self documented RESTfull API's.

  Sources   Download

MIT

The Requires

 

The Development Requires

30/08 2016

v0.1.22

0.1.22.0

Charon is a framework for building self documented RESTfull API's.

  Sources   Download

MIT

The Requires

 

The Development Requires

30/08 2016

v0.1.21

0.1.21.0

Charon is a framework for building self documented RESTfull API's.

  Sources   Download

MIT

The Requires

 

The Development Requires

29/08 2016

v0.1.20

0.1.20.0

Charon is a framework for building self documented RESTfull API's.

  Sources   Download

MIT

The Requires

 

The Development Requires

10/08 2016

v0.1.19

0.1.19.0

Charon is a framework for building self documented RESTfull API's.

  Sources   Download

MIT

The Requires

 

The Development Requires

10/08 2016

v0.1.18

0.1.18.0

Charon is a framework for building self documented RESTfull API's.

  Sources   Download

MIT

The Requires

 

The Development Requires

08/07 2016

v0.1.17

0.1.17.0

Charon is a framework for building self documented RESTfull API's.

  Sources   Download

MIT

The Requires

 

The Development Requires

07/07 2016

v0.1.16

0.1.16.0

Charon is a framework for building self documented RESTfull API's.

  Sources   Download

MIT

The Requires

 

The Development Requires

17/06 2016

v0.1.15

0.1.15.0

Charon is a framework for building self documented RESTfull API's.

  Sources   Download

MIT

The Requires

 

The Development Requires

17/06 2016

v0.1.14

0.1.14.0

Charon is a framework for building self documented RESTfull API's.

  Sources   Download

MIT

The Requires

 

The Development Requires