krayin / rest-api
Installs: 16 426
Dependents: 0
Suggesters: 0
Security: 0
Stars: 4
Watchers: 1
Forks: 4
Open Issues: 1
Requires
- darkaonline/l5-swagger: ^8.6
This package is auto-updated.
Last update: 2024-11-26 10:01:08 UTC
README
Krayin REST API is a medium to use the features of the core Krayin System. By using Krayin REST API, you can integrate your application to serve the default content of Krayin.
1. Requirements
- Krayin: v2.0.0
2. Installation
To install Krayin REST API from your console
For the latest version of rest api
composer require krayin/rest-api
Add the following options to your .env file
SANCTUM_STATEFUL_DOMAINS="${APP_URL}"
L5_SWAGGER_UI_PERSIST_AUTHORIZATION=true
To configure the REST API with L5-Swagger documentation, run the following command
php artisan krayin-rest-api:install
After executing the above command, you will see the API endpoint displayed in the shell.
Alternatively, you can check the API documentation by visiting the following URL in your browser
http://localhost/public/api/admin/documentation
- You can check the L5-Swagger guidelines too regarding the configuration the API documentation.