PHPackages                             gte451f/phalcon-json-api-package - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [HTTP &amp; Networking](/categories/http)
4. /
5. gte451f/phalcon-json-api-package

ActiveLibrary[HTTP &amp; Networking](/categories/http)

gte451f/phalcon-json-api-package
================================

A set of tools designed for use in a Phalcon application to make a RESTish API

3.2.11(7y ago)372.7k12[1 PRs](https://github.com/gte451f/phalcon-json-api-package/pulls)GPL-3.0PHPPHP &gt;=7.0

Since Apr 2Pushed 6y ago12 watchersCompare

[ Source](https://github.com/gte451f/phalcon-json-api-package)[ Packagist](https://packagist.org/packages/gte451f/phalcon-json-api-package)[ RSS](/packages/gte451f-phalcon-json-api-package/feed)WikiDiscussions dev Synced 1mo ago

READMEChangelog (10)Dependencies (1)Versions (26)Used By (0)

phalcon-json-api-package
========================

[](#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
===================

[](#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
=============

[](#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?
====================

[](#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?
=====================

[](#how-is-jsonapi-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?
=============================================

[](#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?
===============================

[](#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?
==================

[](#where-is-the-wiki)

Lots more help is available [here](https://github.com/gte451f/phalcon-json-api-package/wiki).

Where do babies come from?
==========================

[](#where-do-babies-come-from)

[![The Stork Silly!](https://camo.githubusercontent.com/d4b82dd95a7942bb61b95e3b6719b5cb8536358cac200c8e8ce1fe3425e43d72/687474703a2f2f696d67322e77696b69612e6e6f636f6f6b69652e6e65742f5f5f636232303132303531383135303131322f6469736e65792f696d616765732f322f32662f44756d626f2d6469736e657973637265656e636170735f636f6d2d3637322e6a7067 "Dumbo Photo")](https://camo.githubusercontent.com/d4b82dd95a7942bb61b95e3b6719b5cb8536358cac200c8e8ce1fe3425e43d72/687474703a2f2f696d67322e77696b69612e6e6f636f6f6b69652e6e65742f5f5f636232303132303531383135303131322f6469736e65792f696d616765732f322f32662f44756d626f2d6469736e657973637265656e636170735f636f6d2d3637322e6a7067)

###  Health Score

37

—

LowBetter than 83% of packages

Maintenance20

Infrequent updates — may be unmaintained

Popularity29

Limited adoption so far

Community22

Small or concentrated contributor base

Maturity68

Established project with proven stability

 Bus Factor1

Top contributor holds 73.5% of commits — single point of failure

How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window.

**Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores.

**Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement.

**Maturity (30%)** — Project age, version count, PHP version support, and release stability.

###  Release Activity

Cadence

Every ~59 days

Recently: every ~105 days

Total

23

Last Release

2755d ago

Major Versions

v0.1.0-alpha → v1.0.02015-06-15

v1.3-beta → v2.02016-09-15

v2.0 → v3.0-beta2016-11-23

PHP version history (2 changes)v0.1.0-alphaPHP &gt;=5.4.0

v3.0-betaPHP &gt;=7.0

### Community

Maintainers

![](https://www.gravatar.com/avatar/da2dfde6e9352e86e0f6306a355a2b7b56c5c9360d84b2dbc45551b43d4f27d9?d=identicon)[gte451f](/maintainers/gte451f)

---

Top Contributors

[![gte451f](https://avatars.githubusercontent.com/u/2897569?v=4)](https://github.com/gte451f "gte451f (291 commits)")[![igorsantos07](https://avatars.githubusercontent.com/u/532299?v=4)](https://github.com/igorsantos07 "igorsantos07 (64 commits)")[![marceloandrader](https://avatars.githubusercontent.com/u/57552?v=4)](https://github.com/marceloandrader "marceloandrader (28 commits)")[![brisc](https://avatars.githubusercontent.com/u/209979?v=4)](https://github.com/brisc "brisc (3 commits)")[![jking6884](https://avatars.githubusercontent.com/u/4825257?v=4)](https://github.com/jking6884 "jking6884 (3 commits)")[![kumy](https://avatars.githubusercontent.com/u/176794?v=4)](https://github.com/kumy "kumy (2 commits)")[![lougreenwood](https://avatars.githubusercontent.com/u/12051736?v=4)](https://github.com/lougreenwood "lougreenwood (2 commits)")[![andyhot](https://avatars.githubusercontent.com/u/31367?v=4)](https://github.com/andyhot "andyhot (2 commits)")[![cristina-dochitoiu](https://avatars.githubusercontent.com/u/9888747?v=4)](https://github.com/cristina-dochitoiu "cristina-dochitoiu (1 commits)")

---

Tags

jsonapirestphalconrestfulJSON-API

### Embed Badge

![Health badge](/badges/gte451f-phalcon-json-api-package/health.svg)

```
[![Health](https://phpackages.com/badges/gte451f-phalcon-json-api-package/health.svg)](https://phpackages.com/packages/gte451f-phalcon-json-api-package)
```

###  Alternatives

[nategood/httpful

A Readable, Chainable, REST friendly, PHP HTTP Client

1.8k17.2M267](/packages/nategood-httpful)[tuyakhov/yii2-json-api

Implementation of JSON API specification for the Yii framework

140115.6k](/packages/tuyakhov-yii2-json-api)[colymba/silverstripe-restfulapi

SilverStripe RESTful API with a default JSON serializer.

6328.8k](/packages/colymba-silverstripe-restfulapi)[ismaeltoe/osms

PHP library wrapper of the Orange SMS API.

4540.0k](/packages/ismaeltoe-osms)[redound/phalcon-rest-boilerplate

Phalcon REST Boilerplate to use with Phalcon REST library

942.9k](/packages/redound-phalcon-rest-boilerplate)[guanguans/laravel-api-response

Normalize and standardize Laravel API response data structure. - 规范化和标准化 Laravel API 响应数据结构。

485.6k](/packages/guanguans-laravel-api-response)

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)
