Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/jenky/laravel-api
https://github.com/jenky/laravel-api
api laravel rest rest-api
Last synced: 4 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/jenky/laravel-api
- Owner: jenky
- License: mit
- Created: 2016-11-24T11:10:47.000Z (about 8 years ago)
- Default Branch: master
- Last Pushed: 2021-02-20T17:48:31.000Z (almost 4 years ago)
- Last Synced: 2024-11-28T13:09:44.916Z (about 1 month ago)
- Topics: api, laravel, rest, rest-api
- Language: PHP
- Size: 171 KB
- Stars: 2
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.md
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# Laravel API
[![Latest Version on Packagist][ico-version]][link-packagist]
[![Test Status][ico-gh-tests]][link-gh-tests]
[![Codecov][ico-codecov]][link-codecov]
[![Total Downloads][ico-downloads]][link-downloads]
[![Software License][ico-license]](LICENSE.md)
The package provides a nice and easy way to define API routes and format JSON error response.
- [Laravel API](#laravel-api)
- [Install](#install)
- [Installation](#installation)
- [Configuration](#configuration)
- [Usage](#usage)
- [Error response](#error-response)
- [Change log](#change-log)
- [Testing](#testing)
- [Contributing](#contributing)
- [Security](#security)
- [Credits](#credits)
- [License](#license)
## Install
## Installation
You may use Composer to install this package into your Laravel project:
``` bash
$ composer require jenky/laravel-api
```
After installing, publish its assets using the `vendor:publish` Artisan command.
``` bash
php artisan vendor:publish
```
or
``` bash
php artisan vendor:publish --provider="Jenky\LaravelAPI\ApiServiceProvider"
```
## Configuration
After publishing Laravel API's assets, its primary configuration file will be located at `config/api.php`. This configuration file allows you to configure your api route and error response format and each configuration option includes a description of its purpose, so be sure to thoroughly explore this file.
> For Header versioning, if the request doesn't have the `Accept` header with correct format then default version from config will be used.
## Usage
### Error response
Dealing with errors when building an API can be a pain. Instead of manually building error responses you can simply throw an exception and the API will handle the response for you. Just add the trait `ExceptionResponse` to your `app/Exceptions/Handler` and the package will automatically catches the thrown exception and will convert it into its JSON representation.
``` php
You can change the default error response format in `config/api.php` file.
## Change log
Please see [CHANGELOG](CHANGELOG.md) for more information on what has changed recently.
## Testing
``` bash
$ composer test
```
## Contributing
Please see [CONTRIBUTING](CONTRIBUTING.md) and [CODE_OF_CONDUCT](CODE_OF_CONDUCT.md) for details.
## Security
If you discover any security related issues, please email [email protected] instead of using the issue tracker.
## Credits
- [Lynh][link-author]
- [All Contributors][link-contributors]
## License
The MIT License (MIT). Please see [License File](LICENSE.md) for more information.
[ico-version]: https://img.shields.io/packagist/v/jenky/laravel-api.svg
[ico-license]: https://img.shields.io/badge/license-MIT-brightgreen.svg
[ico-travis]: https://img.shields.io/travis/com/jenky/laravel-api/master.svg
[ico-scrutinizer]: https://img.shields.io/scrutinizer/coverage/g/jenky/laravel-api.svg
[ico-code-quality]: https://img.shields.io/scrutinizer/g/jenky/laravel-api.svg
[ico-downloads]: https://img.shields.io/packagist/dt/jenky/laravel-api.svg
[ico-gh-tests]: https://github.com/jenky/laravel-api/workflows/Tests/badge.svg
[ico-codecov]: https://codecov.io/gh/jenky/laravel-api/branch/master/graph/badge.svg
[link-packagist]: https://packagist.org/packages/jenky/laravel-api
[link-travis]: https://travis-ci.com/jenky/laravel-api
[link-scrutinizer]: https://scrutinizer-ci.com/g/jenky/laravel-api/code-structure
[link-code-quality]: https://scrutinizer-ci.com/g/jenky/laravel-api
[link-downloads]: https://packagist.org/packages/jenky/laravel-api
[link-author]: https://github.com/jenky
[link-contributors]: ../../contributors
[link-gh-tests]: https://github.com/jenky/laravel-api/actions
[link-codecov]: https://codecov.io/gh/jenky/laravel-api