bluemedia/api

Bluemedia api

v0.1.5 2020-05-18 19:08 UTC

Requires

• php: ^7.2.5
• illuminate/support: ^7.0

Requires (Dev)

• orchestra/testbench: ^5.0
• phpunit/phpunit: ^8.5

MIT

• Rafał

README

laravel new blog

cd blog/

installataion requirements: https://laravel.com/docs/7.x/installation

2. Install package

composer require bluemedia/api

3. Publish package config

php artisan vendor:publish --tag=bluemedia-api

or

php artisan vendor:publish

and type specific number regarding to the Tag: bluemedia-api

The package config should appear in config directory as "bluemedia-api.php". You can define the api prefix to not collide with your application routes. Default prefix is "bluemedia".

4. Create database

touch database/database.sqlite

sudo nano .env

set database config to:

DB_CONNECTION=sqlite

instead of current configuration: (remove or comment below lines)

DB_CONNECTION=mysql
DB_HOST=127.0.0.1
DB_PORT=3306
DB_DATABASE=laravel
DB_USERNAME=root
DB_PASSWORD=

5. Run migrations

php artisan migrate

6. Seed data

Insert some items data.

php artisan bluemedia:seed

7. Serving Laravel

php artisan serve

8. Test Api Endpoints

8.1 Items available (amount > 0)

curl -X GET http://localhost:8000/bluemedia/items/available

 [
   {
      "id":1,
      "name":"Produkt 1",
      "amount":"4"
   },
   {
      "id":2,
      "name":"Produkt 2",
      "amount":"12"
   },
   {
      "id":4,
      "name":"Produkt 7",
      "amount":"6"
   },
   {
      "id":5,
      "name":"Produkt 8",
      "amount":"2"
   }
]

8.2 Items unavailable (amount = 0)

curl -X GET http://localhost:8000/bluemedia/items/unavailable

[
   {
      "id":3,
      "name":"Produkt 5",
      "amount":"0"
   }
]

8.3 Filter items by amount number

curl -X GET "http://localhost:8000/bluemedia/items?minAmount=5"

[
   {
      "id":2,
      "name":"Produkt 2",
      "amount":"12"
   },
   {
      "id":4,
      "name":"Produkt 7",
      "amount":"6"
   }
]

8.4 Read a resource

curl -X GET http://localhost:8000/bluemedia/item/3

[
   {
      "id":3,
      "name":"Produkt 5",
      "amount":"0"
   }
]

8.5 Delete a resource

curl -X DELETE http://localhost:8000/bluemedia/item/5

{
   "data":{
      "id":5,
      "name":"Produkt 8",
      "amount":"2"
   }
}

8.6 Create a resource

curl -X POST -H "Content-Type:application/json" -d '{"name":"Produkt 10","amount":"10"}' http://localhost:8000/bluemedia/item

{
   "data":{
      "id":12,
      "name":"Produkt 10",
      "amount":"10"
   }
}

8.7 Update a resource

curl -X PUT -H "Content-Type:application/json" -d '{"item_id":"12","name":"Produkt 12","amount":"12"}' http://localhost:8000/bluemedia/item

{
   "data":{
      "id":12,
      "name":"Produkt 12",
      "amount":"12"
   }
}