michelmelo/rest-api

Maintainers

Details

github.com/michelmelo/rest-api

Source

Installs: 2

Dependents: 0

Suggesters: 0

Security: 0

Stars: 0

Watchers: 0

Forks: 4

dev-master 2024-09-05 14:26 UTC

Requires

MIT 8cd2bc878bd4892d28adac971c0e465b5679e218

  • Devansh Bawari <devansh.bawari419.woop@webkul.com>

This package is auto-updated.

Last update: 2024-10-05 14:43:13 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.