0.9.10 2018-05-26 21:33 UTC

This package is auto-updated.

Last update: 2024-08-28 22:14:10 UTC


README

License

摘要

How to create JSON API application

Limoncello App 是一个功能齐全的 OAuth 2.0 JSON API 快速入门应用程序。

它自带以下功能

  • JSON API CRUD 操作(创建、读取、更新和删除)以及一些示例资源,支持 to-oneto-manymany-to-many 关系类型。
  • 支持资源包含、稀疏字段集、排序、过滤和分页等 JSON API 功能
  • 数据库迁移和初始化数据。
  • OAuth 2.0 服务器身份验证和角色授权。
  • 管理用户和角色的管理面板。
  • Cross-Origin Resource Sharing (CORS)。
  • JSON API 错误。
  • API 测试。
  • Web 测试。

支持的功能

  • 多嵌套路径资源包含(例如 posts,posts.user,posts.comments.user)。
  • 在资源和其关系中对多个属性进行过滤和排序。
  • 支持的运算符 =eqequals!=neqnot-equals<ltless-than<=lteless-or-equals>gtgreater-than>=gtegreater-or-equalslikenot-likeinnot-inis-nullnot-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.jsonclient/webpack/base.config.js 中配置

如果您使用 Postman,这里有一组适用于本地服务器的 API 请求(读取用户、过滤用户、创建用户等)。

Run in Postman

这是打开集合时的 Postman 屏幕截图

Requests in Postman

3 启用生产模式(可选)

默认情况下,应用程序安装在 开发模式 下(性能较低,提供测试和开发库)。可以通过以下命令将应用程序切换到 生产模式(性能较高,无测试,无开发库)

$ composer build

与其他框架的性能比较可以在 这里这里 找到。

测试

$ composer test

如何向应用程序添加 Google Auth

您可以在 这里 找到详细说明。

许可证

MIT 许可证