Download the PHP package yarazan/laravel-sanctum-api-only without Composer
On this page you can find all versions of the php package yarazan/laravel-sanctum-api-only. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
FAQ
After the download, you have to make one include require_once('vendor/autoload.php');. After that you have to import the classes with use statements.
Example:
Example:
If you use only one package a project is not needed. But if you use more then one package, without a project it is not possible to import the classes with use statements.
In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
Some PHP packages are not free to download and because of that hosted in private repositories.
In this case some credentials are needed to access such packages.
Please use the auth.json textarea to insert credentials, if a package is coming from a private repository.
You can look here for more information.
- Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
- To use Composer is sometimes complicated. Especially for beginners.
- Composer needs much resources. Sometimes they are not available on a simple webspace.
- If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
- Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Please rate this library. Is it a good library?
Informations about the package laravel-sanctum-api-only
Laravel Sanctum API Only
Overview
This Laravel project is an API-only application designed for robust authentication and authorization using Laravel Sanctum. It includes seamless support for handling UUIDs in binary format across both MySQL and PostgreSQL, along with essential features like root user management, seeders, and role-based policies.
Key Features
1. UUID Handling
- Models requiring UUIDs can use the
HasUuidtrait (App\Traits\HasUuid) to automatically handle UUID generation and binary storage (16 bytes). - Custom validation rule:
BinaryUuidExistsfor checking object existence during validation steps. - Database configuration supports both MySQL and PostgreSQL UUID handling.
2. API Authentication
- Sanctum-based authentication with
/registerand/loginroutes. - Upon successful authentication, the server responds with a JSON object containing a
['token']structure. - Default custom validation rules are implemented for both
/registerand/loginrequests.
3. Extended Token Management
- Includes a modified version of
HasApiTokensasHasApiTokensWithLocationto track device name and location alongside tokens.
4. Root User Management
- Pre-configured root user with a dedicated role (
rootoradmin). - Artisan command
app:generate-root-passwordgenerates a secure root user password and stores it in the.envfile.- Ensure the
.envfile exists before running the command.
- Ensure the
- Default seeders create:
rootrole (or custom role based on your.envconfiguration).- Root user with credentials stored in the
.envfile.
5. Role Management
- Includes an implemented policy and controller for the Role model.
- Role-based access control is applied using Sanctum's
auth:sanctummiddleware.
Getting Started
1. Installation
-
Clone the repository:
-
Navigate to the project directory:
-
Install dependencies:
-
Copy the
.env.examplefile to.env: - Generate the application key:
2. Database Configuration
- Configure your database connection in the
.envfile:
3. UUID Configuration
- For MySQL, UUIDs are stored as
BINARY(16). - For PostgreSQL, UUIDs use the native
UUIDtype.
Usage
Root User Setup
-
Generate a root password:
- This will generate a secure password in the
.envfile.
- This will generate a secure password in the
- Run seeders to create the root role and root user:
Routes
- Define your API routes in the
routes/api.phpfile. - Protect routes with Sanctum middleware:
Example Endpoints
Registration
Login
Seeders
- Default seeders are included for
RoleandUsermodels.
Policies and Validation
Policies
- Role Policy is pre-configured for the
Rolemodel.
Validation Rules
BinaryUuidExistsensures UUID existence during validation.- Custom rules for
/registerand/loginroutes ensure robust input validation.
Contributing
Feel free to fork this repository and submit pull requests. Contributions are always welcome!
License
This project is open-sourced and licensed under the MIT License.
All versions of laravel-sanctum-api-only with dependencies
PHP Build Version
Package Version
Requires
php Version
^8.2
laravel/framework Version ^11.9
laravel/sanctum Version ^4.0
laravel/tinker Version ^2.9
laravel/framework Version ^11.9
laravel/sanctum Version ^4.0
laravel/tinker Version ^2.9
The package yarazan/laravel-sanctum-api-only contains the following files
Loading the files please wait ....