Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/rafal-kucharski/rest-api

Laravel restfull api boilerplate
https://github.com/rafal-kucharski/rest-api

api api-rest boilerplate docker json-api laravel laravel-framework laravel-passport laravel58 php postman restfull-api

Last synced: 2 months ago
JSON representation

Laravel restfull api boilerplate

Host: GitHub
URL: https://github.com/rafal-kucharski/rest-api
Owner: rafal-kucharski
License: mit
Created: 2019-08-07T16:10:25.000Z (over 5 years ago)
Default Branch: master
Last Pushed: 2023-01-04T07:24:23.000Z (almost 2 years ago)
Last Synced: 2024-09-29T18:23:20.102Z (3 months ago)
Topics: api, api-rest, boilerplate, docker, json-api, laravel, laravel-framework, laravel-passport, laravel58, php, postman, restfull-api
Language: PHP
Size: 1.4 MB
Stars: 63
Watchers: 8
Forks: 31
Open Issues: 25
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

# RestAPI - Based on Laravel with Docker
[![Build Status](https://travis-ci.com/nicp0nim/rest-api.svg?branch=master)](https://travis-ci.com/nicp0nim/rest-api)
![Release](https://img.shields.io/github/release/nicp0nim/rest-api)
![Code Size](https://img.shields.io/github/languages/code-size/nicp0nim/rest-api)
![Last commit](https://img.shields.io/github/last-commit/nicp0nim/rest-api)
[![License](https://img.shields.io/github/license/nicp0nim/rest-api)](https://github.com/nicp0nim/rest-api/blob/master/LICENSE)

Laravel 6.0 Restful API boiler plate with:

- auth;
- roles;
- permissions;
- crud;
- json responses;
- phpunit and travis tests;
- database seeder with factories;

## Requirements

As it is build on the Laravel framework, it has a few system requirements.

Of course, all of these requirements are satisfied by the Docker, so it's highly recommended that you use Docker as
your local Laravel development environment.

However, if you are not using Docker, you will need to make sure your server meets the following requirements:
- PHP >= 7.1.3
- MySql >= 5.7
- Composer
- OpenSSL PHP Extension
- PDO PHP Extension
- Mbstring PHP Extension
- Tokenizer PHP Extension
- XML PHP Extension
- Ctype PHP Extension
- JSON PHP Extension
- BCMath PHP Extension

You can check all the laravel related dependecies [here](https://laravel.com/docs/5.7/installation#server-requirements).

## Install application.

1. Clone repository and setup.

`git clone [email protected]:nicp0nim/rest-api.git`

`cd rest-api`

`cp .env.example .env`

2. Start docker.

`docker-compose up -d`
3. Install needed packages.

`docker exec php-fpm composer install`

4. Migrate, install passport and seed database with fake data.

`docker exec php-fpm php artisan key:generate`

`docker exec php-fpm php artisan migrate:fresh --seed`

`docker exec php-fpm php artisan passport:install`

This way is to setup app with docker, but if you want use it without docker just skip second step and replace
from commands `docker exec php-fpm` part. For example 3 step without Docker should look like:

`composer install`

## API Endpoints and Routes
Laravel follows the Model View Controller (MVC) pattern I have creatd models associated with each resource. You can check in the **routes/api.php** file for all the routes that map to controllers in order to send out JSON data that make requests to our API.

```
+-----------+------------
| Method | URI
+-----------+------------
| GET|HEAD | /
+-----------+------------
| GET|HEAD | api/clients
| POST | api/clients
| DELETE | api/clients/{client}
| PUT|PATCH | api/clients/{client}
| GET|HEAD | api/clients/{client}
+-----------+------------
| GET|HEAD | api/roles
| POST | api/roles
| DELETE | api/roles/{client}
| PUT|PATCH | api/roles/{client}
| GET|HEAD | api/roles/{client}
+-----------+------------
| GET|HEAD | api/users
| POST | api/users
| DELETE | api/users/{client}
| PUT|PATCH | api/users/{client}
| GET|HEAD | api/users/{client}
+-----------+------------
| POST | api/login
| GET|HEAD | api/logout
| GET|HEAD | api/profile
| POST | api/register
+-----------+------------
``` ----------------+-----------------+--------------------------------------------------+--------------+ | Name | Action | Middleware | ----------------+-----------------+--------------------------------------------------+--------------+ | | Closure | web | ----------------+-----------------+--------------------------------------------------+--------------+ | clients.index | App\Http\Controllers\ClientController@index | api,auth:api | | clients.store | App\Http\Controllers\ClientController@store | api,auth:api | | clients.destroy | App\Http\Controllers\ClientController@destroy | api,auth:api | | clients.update | App\Http\Controllers\ClientController@update | api,auth:api | | clients.show | App\Http\Controllers\ClientController@show | api,auth:api | ----------------+-----------------+--------------------------------------------------+--------------+ | roles.index | App\Http\Controllers\RoleController@index | api,auth:api | | roles.store | App\Http\Controllers\RoleController@store | api,auth:api | | roles.destroy | App\Http\Controllers\RoleController@destroy | api,auth:api | | roles.update | App\Http\Controllers\RoleController@update | api,auth:api | | roles.show | App\Http\Controllers\RoleController@show | api,auth:api | ----------------+-----------------+--------------------------------------------------+--------------+ | users.index | App\Http\Controllers\UserController@index | api,auth:api | | users.store | App\Http\Controllers\UserController@store | api,auth:api | | users.destroy | App\Http\Controllers\UserController@destroy | api,auth:api | | users.update | App\Http\Controllers\UserController@update | api,auth:api | | users.show | App\Http\Controllers\UserController@show | api,auth:api | ----------------+-----------------+--------------------------------------------------+--------------+ | auth.login | App\Http\Controllers\AuthController@login | api | | auth.logout | App\Http\Controllers\AuthController@logout | api,auth:api | | auth.profile | App\Http\Controllers\AuthController@profile | api,auth:api | | auth.register | App\Http\Controllers\AuthController@register | api | ----------------+-----------------+--------------------------------------------------+--------------+

## API Docs

You can find full postman documentation with example success and error requests [here](https://documenter.getpostman.com/view/1946566/S11BzNAn?version=latest).

#### Example login request

```bash
curl --location --request POST "http://localhost:8080/api/login" \
--header "Content-Type: application/json" \
--header "X-Requested-With: XMLHttpRequest" \
--data "{
\"email\": \"[email protected]\",
\"password\": \"pass\"
}"
```

#### Example login response

```json
{
"success": true,
"data": "eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjE1ZmUyOGI4NTFmM2I1Mjc0MGVkNjFlYzM4ZDgyZmQ2M2ZhYmY1NDM5NjI0ZDZlZDViODAwZDFkMDU2MjBiNjdlYzE3MDNjYzU3MzYwNTcxIn0.eyJhdWQiOiIxIiwianRpIjoiMTVmZTI4Yjg1MWYzYjUyNzQwZWQ2MWVjMzhkODJmZDYzZmFiZjU0Mzk2MjRkNmVkNWI4MDBkMWQwNTYyMGI2N2VjMTcwM2NjNTczNjA1NzEiLCJpYXQiOjE1NjYyNjI5NzEsIm5iZiI6MTU2NjI2Mjk3MSwiZXhwIjoxNTk3ODg1MzcxLCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.aUBUPQDpiHLYR7-ZQHttYPe59ubTBxGgOs8WktDxqv5nlG4WqMIOtfARpdt56NTkD9SrEH1Xo9MaCCLswif25y3xNObHl5MM_X7j1nXE59kHmQt0waqIHq1yCLzVuBtbGkuflZQY4QfM59SKDikGmPNvH98uZjz2wxuah7FF8c5oADxjcBVAuZKfJaewwPSh49qck0dgB-IOpiJ38ihaYiMZCh1DTZJwbot2Pzfs54q9QY2S5_CzBv5z56z4-eb4ylkIn7PtaxcjzZnCWK8f8nxYFQHuKd6awyv6bHK6c3MzFjcXQ1Zl9oUUHvrRV-9qIzv6Ot73amVKitDafOXmaC6_oG-bURcl8wVOMVi9GSkrc2j6ZjljDs2w83YhNtglT9Fy10CoDMUBh6HwaLejjwv91dTRhUQ91CoCRtoFCIp7Pq2OG5bM3cNDCUjsn72gCEG_u4WJ_aK8zIx7tmhmfU-nvtctEFoMSSJJ1NYeE0W53jahFeTVVSEd7yJEgk53mlSNgKUw3Q2XfonV6bW-iD2BPd_XCGobh9uIPt5PQdoGZUDP75-njkPIYqUELvSR1n3pUJwLx4smBK-rgzk8TR7LShG2P5gH1AP6qAtrs0ufwHH_3-JL5U5tlGAt7_t3x23opnX-I63KFwD5OhJl_39ran3B91xUwD8y2m-6VQ0"
}
```

#### Example authorized request with token

```bash
curl --location --request GET "http://localhost:8080/api/profile" \
--header "Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjM1ZjQ5NTU1N2QzYmEyNjM5OTQzYmQzY2JlMTU1MTI0NmIyZmJiMzc4NGY2ZTJmNTgwOGZlM2Y3YjNiMGM0ZjlkZTM2MzY2ZGNkZTFhOWJjIn0.eyJhdWQiOiIxIiwianRpIjoiMzVmNDk1NTU3ZDNiYTI2Mzk5NDNiZDNjYmUxNTUxMjQ2YjJmYmIzNzg0ZjZlMmY1ODA4ZmUzZjdiM2IwYzRmOWRlMzYzNjZkY2RlMWE5YmMiLCJpYXQiOjE1NjYyNjQ2NjksIm5iZiI6MTU2NjI2NDY2OSwiZXhwIjoxNTk3ODg3MDY5LCJzdWIiOiIyIiwic2NvcGVzIjpbXX0.Xf7HGFczhfbXNMtycA3k9O-0FYYkH4Oj-LLJQm4P5br5DwJOf0ScQ0Gb5wKA2k6T1QuYNy6D4h_wGzCUICuvmFHyQ0pTlkUL_2RjefjHy1mIuTPCUkgxFVjAn0qUIBgakrb_I2OXGgRZlO_00eyYRiSaMBtcuEkRljVpJG8EL8JDdTFFEqgoSXrGDfQqubBEW0_IjDw33NXrFVtK-aJQdkTpGNUwr0aSVMT_GcX7u7vJjvCa3Jc50unGXZI6VDpwxsvndAyuuvu8AbRhmN7TNJhCNynT55m4X0ZY9xLH_WAEoT7uI5ei5DdBAfH1_Ux0nJxHLFGaXI15N_OAw8noVgPSPps8Bbn9fsWu7ZqGvj-2gUupVrWS1FVk5qBYzKnV4Osdsl0pRjVfY9yghIRTCGonxCU_A2Fl-i8OUVPUl6iqGxiko2KBo8qqLWQbT3IkUXyB578DAIqgqfZ9gr122B0J5ukyIYtLLHKo0HqYc9NjB2K11ntfB6SPXJBEY6Xrts8xm_0uT1fJ2pIXuvICtC-cUBDioUZ842ijeOJm4h_vESzsqJXQ4Xp32PCvcjHxO9X9EJe5JnDdHD5nlVDeEl4ZtpBZ4zZeef3yXsdMPxwGGiTrwNMZyLHnzWdiNAhZfo13Pk4z9XswDK8omIdtKuEPAIQXT2Z9Gu4keVaI0fQ" \
--header "Content-Type: application/json" \
--header "X-Requested-With: XMLHttpRequest" \
--data ""
```

## Tests

As default tests are configured to work with travis when you push commit to github repo.

If you want to run tests locally go to `phpunit.xml` file in root directory and change `DB_CONNECTION` value to `sqlite
`.

Then as normally run command `./vendor/bin/phpunit`.

Remember to change that value back for `testing` when you push repo to github, otherwize your commit test will
fail.