Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/gte451f/phalcon-json-api-package
A composer package designed to help you create a JSON:API in Phalcon
https://github.com/gte451f/phalcon-json-api-package
Last synced: 3 months ago
JSON representation
A composer package designed to help you create a JSON:API in Phalcon
- Host: GitHub
- URL: https://github.com/gte451f/phalcon-json-api-package
- Owner: gte451f
- License: lgpl-3.0
- Created: 2015-03-19T23:24:10.000Z (over 9 years ago)
- Default Branch: dev
- Last Pushed: 2019-05-30T11:37:07.000Z (over 5 years ago)
- Last Synced: 2024-06-21T19:00:48.628Z (5 months ago)
- Language: PHP
- Homepage:
- Size: 836 KB
- Stars: 36
- Watchers: 13
- Forks: 12
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-phalcon - phalcon-json-api-package - A composer package designed to help you create a JSON:API in Phalcon (RESTful)
README
# phalcon-json-api-package
A composer package designed to help you create a JSON:API in Phalcon
What happens when a PHP developer wants to create an API to drive their client-side SPA? Well you start with [Phalcon](http://phalconphp.com/en/) (A modern super fast framework) loosely follow the [JSON:API](http://jsonapi.org/) and package it up for [Composer](https://getcomposer.org/). The result is the phalcon-json-api package (herafter referred to as the API) so enjoy.
# System Requirements
- Phalcon 3.x
- SQL persistance layer (ie. MYSQL, MariaDB) Make sure the database is supported by [Phalcon's Database Abstraction Layer](https://docs.phalconphp.com/en/latest/reference/db.html).
- PHP Version 7+
# Release Notes
Read up on the latest plans for the API [here](https://github.com/gte451f/phalcon-json-api-package/wiki/Release-Plans).
# How is Phalcon used?
Phalcon is the underlying framework this project depends on. Any user of the API package will need to have a working installation of Phalcon already installed on their system. The API makes extensive use of Phalcon sub systems including the ORM, Router and Service Locator.
# How is JSON:API used?
The Phalcon JSON API package attempts to follow the JSON API as closely as possible. There are several enhancements this project incorporates beyond the JSON API specification.
# How can I quickly see this project in action?
New folks are encouraged to download and install the [sister project](https://github.com/gte451f/phalcon-json-api) that acts as a simple example application to demonstrate how one could use the API. This simple application include all the building blocks that make up the api including use of traditional Phalcon objects like Controllers and Models along with objects designed for use in the API such as Entities, Route and SearchHelpers.
# How can I install this project?
Aside from meeting the system requirements, you should include this project in your composer file. Here is an example composer file that includes a few extra libraries needed for testing and timing api responses.
```
{
"require": {
"jsanc623/phpbenchtime": "dev-master",
"gte451f/phalcon-json-api-package": "dev-master"
},
"require-dev": {
"codeception/codeception": "*",
"flow/jsonpath": "dev-master"
}
}
```
# Where is the wiki?
Lots more help is available [here](https://github.com/gte451f/phalcon-json-api-package/wiki).
# Where do babies come from?
