limoncello-php / app
0.9.10
2018-05-26 21:33 UTC
Requires
- php: >=7.1.0
- limoncello-php/framework: ^0.9.1
- twig/extensions: ^1.5
- vlucas/phpdotenv: ^2.3
Requires (Dev)
- doctrine/dbal: ^2.5.0
- filp/whoops: ^2.1
- fzaninotto/faker: ^1.7
- limoncello-php/testing: ^0.9.1
- mockery/mockery: ^1.0
- phpmd/phpmd: ^2.6
- phpunit/phpunit: ^7.0
- squizlabs/php_codesniffer: ^2.9
README
摘要
Limoncello App 是一个功能齐全的 OAuth 2.0 JSON API 快速入门应用程序。
它自带以下功能
- JSON API CRUD 操作(创建、读取、更新和删除)以及一些示例资源,支持
to-one
、to-many
和many-to-many
关系类型。 - 支持资源包含、稀疏字段集、排序、过滤和分页等 JSON API 功能。
- 数据库迁移和初始化数据。
- OAuth 2.0 服务器身份验证和角色授权。
- 管理用户和角色的管理面板。
- Cross-Origin Resource Sharing (CORS)。
- JSON API 错误。
- API 测试。
- Web 测试。
支持的功能
- 多嵌套路径资源包含(例如
posts,posts.user,posts.comments.user
)。 - 在资源和其关系中对多个属性进行过滤和排序。
- 支持的运算符
=
、eq
、equals
、!=
、neq
、not-equals
、<
、lt
、less-than
、<=
、lte
、less-or-equals
、>
、gt
、greater-than
、>=
、gte
、greater-or-equals
、like
、not-like
、in
、not-in
、is-null
、not-null
。 - 分页适用于主资源和关系中的资源。最大资源数量的限制可以配置。
基于
- Zend Diactoros
- Doctrine
- Pimple
- Monolog
- FastRoute
- Twig
- JSON API 实现
- Cross-Origin Resource Sharing
- 使用 ❤️ Limoncello 构建
如果您计划开发 JSON API,它将是一个很好的起点。
请随时提问,感谢您用 ⭐ 支持项目。
安装
1 创建项目
$ composer create-project --prefer-dist limoncello-php/app app_name
$ cd app_name
推荐额外步骤
$ npm install
或
$ yarn install
2 运行服务器
应用程序在端口 8080 上运行 PHP 内置服务器
$ composer serve
推荐
$ npm serve
或
$ yarn serve
端口号可以在
composer.json
或client/webpack/base.config.js
中配置
如果您使用 Postman
,这里有一组适用于本地服务器的 API 请求(读取用户、过滤用户、创建用户等)。
这是打开集合时的 Postman
屏幕截图
3 启用生产模式(可选)
默认情况下,应用程序安装在 开发模式 下(性能较低,提供测试和开发库)。可以通过以下命令将应用程序切换到 生产模式(性能较高,无测试,无开发库)
$ composer build
测试
$ composer test
如何向应用程序添加 Google Auth
您可以在 这里 找到详细说明。