Frame Work Used : Laravel Version : 5.8 This a web application framework with expressive, elegant syntax. We believe development must be an enjoyable and creative experience to be truly fulfilling. Laravel Framework takes the pain out of development by easing common tasks used in many web projects, such as:
- Laravel Passport - For authentication using tokens
- laravel-cors - For handling Cross-Origin Resource Sharing (CORS)
app- Contains all the Eloquent modelsapp/Http/Controllers/Api- Contains all the api controllersapp/Http/Middleware- Contains the auth middlewareapp/standard_code/- Contains the files implementing the favorite featureconfig- Contains all the application configuration filesdatabase/factories- Contains the model factory for all the modelsdatabase/migrations- Contains all the database migrationsdatabase/seeds- Contains the database seederroutes- Contains all the api routes defined in api.php filetests- Contains all the application teststests/Feature/Api- Contains all the api tests
.env- Environment variables can be set in this file
Note : You can quickly set the database information and other variables in this file and have the application fully working.
Run the laravel development server
php artisan serve
The api can now be accessed at
http://localhost:8000/api
Request headers
| Required | Key | Value |
|---|---|---|
| Yes | Content-Type | application/json |
| Yes | X-Requested-With | XMLHttpRequest |
| Optional | Authorization | Token {JWT} |
Refer the api specification for more info.
This applications uses Passport to handle authentication. The token is passed with each request using the Authorization header with Bearer Token scheme.