lsshu/site-api

dev

v0.0.0 2024-10-16 16:14 UTC

Requires

• php: >=7.4.0
• spatie/laravel-permission: ^5.11.1
• tymon/jwt-auth: ^1.0-dev

Requires (Dev)

• phpunit/phpunit: ~6.0

MIT

• lsshu

• api
• laravel

README

Laravel is a web application

Installation

This package requires PHP 7.4+ and Laravel 8.5

First, install laravel 8.5, and make sure that the database connection settings are correct.

composer require lsshu/site-api

Then run these commands to publish assets and config：

php artisan vendor:publish --provider="Lsshu\Site\Api\ServiceProvider" --tag="config"

After run command you can find config file in config/permisstion.php config/jwt.php config/site-api.php, in this file you can change the install directory,db connection or table names.

Add the following configuration to file config/filesystems.php

 'disks' => [
        ·
        ·
        ·
        'root' => [
            'driver' => 'local',
            'root' => base_path('/')
        ]
    ]

migrate.

php artisan migrate

At last run following command to finish install permission.

php artisan site-api:seed-permission

Open http://localhost/site-api/ in browser,Test whether the installation is successful 🏅.

Add the following configuration to file config/auth.php

'guards' => [
        ·
        ·
        ·
        'site-api' => [
            'driver' => 'jwt',
            'provider' => 'roots',
            'hash' => false,
        ],
    ],


'providers' => [
        ·
        ·
        ·
        'roots' => [
            'driver' => 'eloquent',
            'model' => Lsshu\Site\Api\Models\SystemUser::class,
        ],
    ],

Generate JWT encryption key

php artisan jwt:secret

Configurations

The file config/site-api.php contains an array of configurations, you can find the default configurations in there.

在 app/Http/Kernel.php 中找到 protected $routeMiddleware = [···]

protected $routeMiddleware = [
        .
        .
        .
        // 检查权限
        'check.permissions' => \Lsshu\Site\Api\Middleware\CheckPermissions::class
    ];

License

The Laravel framework is open-sourced software licensed under the MIT license.