Download the PHP package catlabinteractive/charon without Composer
On this page you can find all versions of the php package catlabinteractive/charon. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download catlabinteractive/charon
More information about catlabinteractive/charon
Files in catlabinteractive/charon
Package charon
Short Description Charon is a framework for building self documented RESTful API's.
License MIT
FAQ
Example:
In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
- Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
- To use Composer is sometimes complicated. Especially for beginners.
- Composer needs much resources. Sometimes they are not available on a simple webspace.
- If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
- Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Informations about the package charon
Charon
Fractal on steroids.
What?
Charon is a PHP framework for building self documented RESTful API's.
Please visit our website for more information.
Getting started
While Charon can be used with any framework, I have created a laravel skeleton project to get you started fast.
Installation
composer create-project catlabinteractive/laravel-charon api
Configuration
Please follow the instructions on https://github.com/CatLabInteractive/laravel-charon-template
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
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
Documentation
By default, Charon generates Swagger 2.0 documentation. Other documentors can be implemented by implementing the interface.
Frameworks
Charon works very well with Laravel, but the library is built so that it can be incorporated in other frameworks.
An ORM is not required, but makes implementing certain functionality (like pagination and filtering) a lot easier.
Context options
For both fields and expand parameters: add a * to repeat the field (for recursive models).
