此包已被弃用且不再维护。未建议替代包。

此包提供了一些辅助方法,以加快API开发。

v0.1.5 2020-10-04 18:32 UTC

README

由AMBERSIVE KG / Manuel Pirker-Ihl (manuel.pirker-ihl@ambersive.com / @leganz on Twitter)

关于

本项目的主要目标是提供一个快速创建API端点的测试环境。项目将自动创建所需的PHP文件,并确保提供最低的质量标准。

本包将帮助您创建

  • 模型(+文档)
  • 资源(+文档)
  • 集合(+文档)
  • 控制器(+文档)
  • 测试(模型/控制器)
  • 策略
  • 工厂

基于一些简单的YAML模式文件。

本包还提供了一些开箱即用的端点实现(RESTful端点),如

  • 登录
  • 注册
  • 找回密码
  • 权限(CRUD)
  • 角色(CRUD)

每个版本的更改可以在CHANGELOG.md中阅读。

支持的数据库

当前支持的数据库有

  • MySQL 5.x
  • Sqlite

请注意,由于数据库技术的限制(例如关系解析),某些功能可能不可用。

使用的包

其他要求

此包使用prettier通过命令行自动格式化文件。NodeJs是必需的。

安装

1) 运行安装命令

composer require ambersive/api

2) 安装所有Nodejs需求

在您开始处理之前,请删除所有默认迁移文件。(例如,对于用户表)。请注意,以下命令将把您的配置文件夹中的某些文件移动到“ori”文件夹作为备份,因为此包将覆盖基本auth.php配置文件中的某些设置。

php artisan api:init

然后迁移数据库以确保所有所需的表都已迁移。

php artisan migrate

默认设置

此包提供了一些标准实现,例如

  • 登录
  • 注册
  • 忘记密码/设置密码
  • 用户端点(包括当前用户)

以及一些基本的权限、角色和用户端点。一些基本端点可以被替换和自定义。有关更多信息,请参阅文档。

种子

本包还包括一些种子,包括用户种子。在设置过程中,种子文件将创建在 resources/seedfiles 目录中。

创建文件夹和文件

Schema文件和大部分所需文件存储在特定文件夹中。通过ambersive-api配置文件,可以设置所有这些路径。以下命令将创建所需的文件夹。如果您运行了api:init命令,则不需要运行此命令。

php artisan api:prepare

文档

有关此包的更多信息可以在 此处 找到。