lolltec / limoncello-php-app
dev-master
2020-11-19 11:26 UTC
Requires
- php: >=7.1.0
- ext-pdo: *
- lolltec/limoncello-php-framework: dev-master
- neomerx/json-api: ^3.0.0
- vlucas/phpdotenv: ^2.3
Requires (Dev)
- ext-json: *
- doctrine/dbal: ~2.7.0
- filp/whoops: ^2.1
- fzaninotto/faker: ^1.7
- lolltec/limoncello-php-component-testing: dev-master
- mockery/mockery: ^1.0
- phpmd/phpmd: ^2.6
- phpunit/phpunit: ^7.0
- squizlabs/php_codesniffer: ^2.9
This package is auto-updated.
Last update: 2024-10-01 00:14:40 UTC
README
摘要
Limoncello App 是一个功能齐全的 OAuth 2.0 JSON API 快速入门应用程序。
它自带以下功能:
- JSON API CRUD 操作(创建、读取、更新和删除)适用于几种示例资源,支持
to-one
、to-many
和many-to-many
关系类型。 - 支持资源包含、稀疏字段集、排序、过滤和分页等 JSON API 功能。
- 数据库迁移和初始化数据。
- OAuth 2.0 服务器身份验证和角色授权。
- 管理用户和角色的管理面板。
- 跨源资源共享 (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
。 - 分页适用于主要资源和关系中的资源。最大资源数量限制可配置。
基于
如果您计划开发 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 添加到应用程序中
您可以在此找到详细说明 这里。