joselfonseca/laravel-api

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

Laravel API 快速入门套件将为您提供创建 Laravel API 所需的大部分样板代码。

维护者

详细信息

github.com/joselfonseca/laravel-api

源代码

问题

安装次数: 2,462

依赖关系: 0

建议者: 0

安全: 0

星标: 407

关注者: 26

分支: 116

开放问题: 1

语言：Blade

类型：项目

V12.0.0 2022-08-12 17:30 UTC

Requires

Requires (Dev)

MIT 4d46d1d4ebd29de95880ce1ab87c131f2ebb462a

frameworkrestapioauth2laravel

This package is auto-updated.

Last update: 2023-02-01 19:26:31 UTC

README

Total Downloads License

Laravel API 快速入门套件将为您提供制作 Everyone 都会喜爱的 API 的工具，API 身份验证已通过 passport 提供。

以下是已安装的包列表

安装

要安装项目，您可以使用 composer

composer create-project joselfonseca/laravel-api new-api

修改 .env 文件以适应您的需求

APP_NAME=Laravel
APP_ENV=local
APP_KEY=
APP_DEBUG=true
APP_URL=https://

LOG_CHANNEL=stack
LOG_LEVEL=debug

DB_CONNECTION=mysql
DB_HOST=127.0.0.1
DB_PORT=3306
DB_DATABASE=laravel
DB_USERNAME=root
DB_PASSWORD=

BROADCAST_DRIVER=log
CACHE_DRIVER=file
QUEUE_CONNECTION=sync
SESSION_DRIVER=file
SESSION_LIFETIME=120

MEMCACHED_HOST=127.0.0.1

REDIS_HOST=127.0.0.1
REDIS_PASSWORD=null
REDIS_PORT=6379

MAIL_MAILER=smtp
MAIL_HOST=mailhog
MAIL_PORT=1025
MAIL_USERNAME=null
MAIL_PASSWORD=null
MAIL_ENCRYPTION=null
MAIL_FROM_ADDRESS=null
MAIL_FROM_NAME="${APP_NAME}"

AWS_ACCESS_KEY_ID=
AWS_SECRET_ACCESS_KEY=
AWS_DEFAULT_REGION=us-east-1
AWS_BUCKET=

PUSHER_APP_ID=
PUSHER_APP_KEY=
PUSHER_APP_SECRET=
PUSHER_APP_CLUSTER=mt1

MIX_PUSHER_APP_KEY="${PUSHER_APP_KEY}"
MIX_PUSHER_APP_CLUSTER="${PUSHER_APP_CLUSTER}"

当您设置好数据库连接的 .env 文件后，您可以运行迁移

php artisan migrate

然后运行 php artisan passport:install

运行 php artisan db:seed，您应该会有一个新用户，其角色和权限已设置好

测试

导航到项目根目录，在安装所有 composer 依赖项并在创建 .env 文件后，运行 vendor/bin/phpunit

API 文档

项目使用 API 蓝图作为 API 规范，并使用 Aglio 来渲染 API 文档，请在本机安装 aglio 和 merge-apib，然后您可以使用以下命令编译和渲染 API 文档

composer api-docs

许可证

Laravel API 快速入门套件是开源软件，受 MIT 许可证 许可。