Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/coloredcow/laravel-mobile-api
https://github.com/coloredcow/laravel-mobile-api
Last synced: 19 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/coloredcow/laravel-mobile-api
- Owner: ColoredCow
- License: mit
- Created: 2018-10-24T12:06:01.000Z (about 6 years ago)
- Default Branch: master
- Last Pushed: 2024-07-02T06:28:27.000Z (7 months ago)
- Last Synced: 2024-12-12T07:12:06.379Z (about 1 month ago)
- Language: PHP
- Size: 19.5 KB
- Stars: 1
- Watchers: 1
- Forks: 1
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Laravel Mobile API
# Prerequisite
This package requires a basic understanding of [Laravel Passport](https://laravel.com/docs/5.6/passport).
## Installation
1. Add this package in your project.
2. Now add the trait `CanHaveAPIEndPoints` in the controller that will contribute in the mobile service. You can also add this trait in the base controller and use it. Now you can use **returnFormattedResponse** method to send the respose. This function will check the request and send the reponse accordingly.
#### Handling web responses only
The first argument is the array of data you pass to the view. The second argument is the view name.
```php
return $this->returnFormattedResponse(['projects' => $projects], 'project.index');
```
#### Handling both web and API responses
Use two closures for sending different responses for web and api.
```php
return $this->returnFormattedResponse(
function () {
// api response here
},
function () {
// web response here
}
);
```
## Exception Handling
For clear error responses you need to add the trait in the **App\Exceptions\Handler** class and add the following code snippt in report method.
```php
public function render($request, Exception $exception)
{
if($this->isApi()) {
return $this->renderErrorResponseForAPI($exception);
}
return parent::render($request, $exception);
}
```
## Auth Middleware
If you want to set the auth user for every authenticated route then add `RestApiMiddleware` in your project and apply in on routes.
In kernel.php
```php
'restapi' => ColoredCow\LaravelMobileAPI\RestAPIMiddleware::class,
```
In routes/api.php file
```php
Route::group(['middleware' => ['auth:api', 'restapi:auth'] ], function () {
// routes
});
```