dynamics-unlimited/laravel-api-template

此包的最新版本(1.0.1)没有可用的许可证信息。

适用于Kairnial项目的通用API模板。

1.0.1 2023-04-21 09:27 UTC

This package is auto-updated.

Last update: 2024-09-21 12:32:14 UTC


README

通知偏好微服务

安装

  • 安装WSL with UbuntuV22.04
  • 如果WSL中没有安装Postgresql及其php驱动,请安装它们
  • 使用init-db.sh脚本创建一个新的Postgresql数据库(在内部调整用户和数据库名称)
  • 从您的Ubuntu终端,导航到项目的根目录,并执行
composer install
  • 然后执行数据库迁移
php artisan migrate
  • 要向您的数据库添加一些测试数据,执行
php artisan db:seed

从模板创建项目

使用composer根据此模板创建一个新项目,使用

composer create-project dynamics-unlimited/laravel-api-template <local-directory>

环境变量

复制/粘贴 .env.example 然后将新文件重命名为 '.env'。根据您的环境更新文件内容。

JWT密钥

将相应环境的public密钥复制到storage/app/keys/public(public为一个文件)

API文档

要生成API文档,使用

php artisan l5-swagger:generate

Swagger文档可通过此路由访问:{{url}}/api/documentation

Redoc文档可通过此路由访问:{{url}}/api/redoc

部署说明

执行以下命令

php artisan l5-swagger:generate