Book API

This book API calls an external API service which is the Ice And Fire API to get information about books and also implements its own database and has basic CRUD functions. It also includes the feature tests

Getting Started

Requirements

• PHP 8.1 and above
• MySQL
• Composer

Clone the Repository on target machine:

git clone https://github.com/kayxleem/books-api.git
cd books-api

Set up your .env

DB_DATABASE=laravel (Replace with yours)
DB_USERNAME=root (Replace with yours)
DB_PASSWORD= (Replace with yours)

generate your laravel key

php artisan key:generate

Install dependencies (if you have composer locally):

composer install

or 

composer update

Run database migrations:

php artisan migrate

Run Test

php artisan test

Seed the database:

php artisan db:seed --class=BookSeeder

Usage

The API should be available at http://localhost:3000/api (You can change the APP_PORT in .env file) if you are using artisan serve.

End Points

External endpoint

GET /api/external-books?name=:nameOfABook

Returns result from Ice And Fire API

Create

POST /api/v1/books

expected inputs

● name
● isbn
● authors
● country
● number_of_pages
● publisher
● release_date

Read

GET /api/v1/books

Read End points can also be searched with filters

GET /api/v1/books?filter[name]=game

Filters can also be chained

?filter[name]=game&filter[country]=United&filter[publisher]=Bantam&filter[release_date]=1996

Update

PATCH /api/v1/books/:id

Delete

DELETE /api/v1/books/:id

Alternative Delete

POST /api/v1/books/:id/delete