README

一个用于帮助您在Phalcon中创建JSON:API的Composer包

当PHP开发者想创建一个API来驱动他们的客户端SPA时会发生什么？嗯，您可以从Phalcon（一个现代的超级快速框架）开始，松散地遵循JSON:API规范，并将其打包为Composer。结果是phalcon-json-api包（以下简称为API），所以请享受。

系统需求

Phalcon 3.x
SQL持久层（例如，MYSQL，MariaDB）。请确保数据库由Phalcon数据库抽象层支持。
PHP版本 7+

发行说明

了解API的最新计划在这里。

Phalcon是如何使用的？

Phalcon是这个项目依赖的底层框架。任何API包的使用者都需要在他们的系统上安装一个有效的Phalcon安装。API广泛使用了Phalcon子系统，包括ORM、路由和服务定位器。

如何使用JSON:API？

Phalcon JSON API包试图尽可能遵循JSON API规范。该项目在JSON API规范之外还包含了一些增强功能。

如何快速看到这个项目的实际应用？

新用户被鼓励下载和安装姊妹项目，该项目是一个简单的示例应用程序，演示了如何使用API。这个简单的应用程序包括了构成API的所有构建块，包括使用传统的Phalcon对象（如控制器和模型）以及专为API使用设计的对象（如实体、路由和搜索助手）。

如何安装此项目？

除了满足系统要求外，您还应在composer文件中包含此项目。以下是一个包含一些额外库的示例composer文件，这些库用于测试和计时API响应。

{
    "require": {
        "jsanc623/phpbenchtime": "dev-master",
        "gte451f/phalcon-json-api-package": "dev-master"
    },
    "require-dev": {
        "codeception/codeception": "*",
        "flow/jsonpath": "dev-master"
    }
}

维基在哪里？

更多帮助信息在这里。

gte451f / phalcon-json-api-package

维护者

详细信息