books-api2-server

Simple CRUD API access for managing books, works with user roles and restricts books access for every single request.

If you enjoy this API example, please give a star to this repo

The goal of this example is to show how API (server part) can be done in Laravel with passport authentication. There are books that can be managed by authors (each author has access to every one of the books). Each of the books can be read by reader, each reader only has the ability to ready any kind of data related with any book. Also to list all books. Every book is part of a category.

Categories have: id, name

Users have: name, email, password, role - [author, reader], receive notifications.

Books have: title, description, author, category, cover image (base64 passed to API)

Authentication - works for both user and admin

Login

Register

Me

The following two sections are accessable only after successful authorization for both author and reader

Categories - restricts access for every request to the data

List all (both author and reader)

Create new

Books - restricts access for every request to the data

List all (both author and reader)

Create new (author only)

Show (both author and user)

Update (admin only)

Delete (admin only)

> Let's start setting up the application

Create an .env file with database settings
, set the QUEUE_CONNECTION=database
Create a database - for MySQL I suggest you to set up the encoding as UTF8MB4_UNICODE_CI
Run composer install to install all project dependencies
Create and seed the database php artisan migrate:fresh --seed
Run php artisan passport:keys --force (In case of auth problems try php artisan passport:install)
Run php artisan passport:client --password and set for name BooksApiPac
Run php artisan storage:link

Here are the routes that navigate the API - run: php artisan routes:list

Start the server php artisan serve

Then run postman and inside try the routes:

REGISTER http://127.0.0.1:8000/api/register

Method: POST

Headers:

key	value
Accept	application/json

Params (Body->form-data):

key	value
name	_new_name_
email	_new_email_
password	_new_password_
confirm_password	_new_password_confirmation_
role	author / reader
receive_notifications	0 / 1

On success the response shall be similar to this


{
    "message": "Successfully created user!"
}

Since the email has to be unique in the DB, if someone try to register the user with same email, then this error appear


{
    "error": {
        "email": [
            "The email has already been taken."
        ]
    }
}

LOGIN http://127.0.0.1:8000/api/auth/login

Method: POST

Headers:

key	value
Accept	application/json

Params (Body->form-data):

key	value
email	_email_
password	_password_

The response shall be similar to this


{
    "token_type": "Bearer",
    "expires_in": 900,
    "access_token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJhdWQiOiI0IiwianRpIjoiOGQ4MDdhY2ZlYzdkZDhiNzU3Yzc2OGYwNDU1NmFkZjBhYTcxYjFhMTZiODYyMmU1NjU2Yzc3N2ZlZjQzZTVjZjQ3ZDgzZWU1MjRlNWU0ZTIiLCJpYXQiOjE1ODA1NjU0ODcsIm5iZiI6MTU4MDU2NTQ4NywiZXhwIjoxNTgwNTY2Mzg3LCJzdWIiOiI2Iiwic2NvcGVzIjpbXX0.pIgIJ_LdQkYMirKRUhg_Oj-_PtLPtaA0dOWUb6Szi0HWb8frnqV-z8H_FzrqKEQnoTsJEmiHCECaf9ByBc7bz3ZBeBOn9pwhtgDhyKv3n9JuyTRoU8lXCVT3qxu-ZNKFOERjff0IAKe6m7tPT_DiZcol-JgQ7Qc0YI_8XWQgVYWFVEU1cWG9oXccc6kUlRL6G5v4NYUQ1nwV7vdZt0Bot_IOzpN-f898kp1K7qZ5W_GFEkXV8eda_QxPgi65MC4XhRuKNo5a1m-R5UmiI2B0hJ8r2ZH62ECbWXEpi5u35XCUqzp4smtFXv_nUEwkIDZ44msOlV4_l6scGfDUDDHA6hfiUfCoa8pMCLrLGXm3kWKh5XZaDuEdg-irir_3MA3rfKbVcWaWuJUKiCI5zIQ6cOsPEBp9gHfGSYdkgJ7l99wcsQQBvRnlrRSk_u8sDh72YsBc8oOa1Z5vxxk9AnxR5hJ9tgqKy6_smghfM9RTFL2OLJdxU9j-J-Iq7smn0-xNrP4JylJ9Z6iQaf_wUkaP7vlH0JxfdXHWn77Na8hii886WOpQAVuUbiCfwNDmzHRKZCCO6xJ238_iV4HvCyPCQ4eAEt3rz_pDcTtOT60szxEjpHSxpRw-Cr0NLXJud5BSuXwDwhjDdbl3SvbclDY1IcgpZNEsGFVQXlST-mT_rSc",
    "refresh_token": "def50200128cdab05ecc6285bba4394220c982fff089a1afa9bb3da13759e4f03a866f6a5028a05e1f108f7d636d7da2b36b3e13a92eec8dcef0a18913434175d308d043c6e229d20beec8d747ed0236150f39b71e768215231183cad3bbad1bdeb6fedd481eff700d437ded9f78ab44690a0d235b7950eb0e8bd31c4f5e01a31b2644451e77768af08ce822d2710d0525847ff6454da98226019079c61fb93367848274960d7d9e8cfe47c5c972b37ad271751737411938036ecb283c87c028263822c92d730df3ba0b480ef5dfa40f704aa59c10c369bd46160a2c746373b386c559292d397c21ff4a2bb7958ac7a36253cdae0288cce861a3d5f7ee40152dd1fdb23ce0ac48ee5c9ad9b98efd9cb87ba3529c4bbc2adddd23f7d63e1a96c5b68ad16c0086503c9e0a7d854a84bd412b7a9e6b69f0b7e5ccfd0cf1b8f878abc521396e462a28b685c905679465ed6f6a7e73c6e5601c4d638485f2f689e70189"
}

If some or both of credentials are wrong or missing, the response will give status of 401 and will be

{ "error": "invalid_grant", "error_description": "The provided authorization grant (e.g., authorization code, resource owner credentials) or refresh token is invalid, expired, revoked, does not match the redirection URI used in the authorization request, or was issued to another client.", "hint": "", "message": "The provided authorization grant (e.g., authorization code, resource owner credentials) or refresh token is invalid, expired, revoked, does not match the redirection URI used in the authorization request, or was issued to another client." }

Me http://127.0.0.1:8000/api/me

Method: POST

Headers:

key	value
Authorization	Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJhdWQiOiIxIiwianRpIjoiYmQyZmY3ZmIxMzdkZjZiNGQ5MjRlZTJiNDllODE2ODNkNWYzNDYzMWNhYjY5Y2MwMzdhNTViZTQ5MzJlZTM1NTZiNDVkNDAxZDk5NDVkODkiLCJpYXQiOjE1NzkxNjg4MzUsIm5iZiI6MTU3OTE2ODgzNSwiZXhwIjoxNjEwNzkxMjM0LCJzdWIiOiI4Iiwic2NvcGVzIjpbXX0.O2zk3xl7MZ0kpzWcNX9PCz1_X_40srqu2VrZAfWUIfwETPsCrRRp_GZCeLsezZzsOOJYapZTR_piyYtsP5fq_z4UcrYfW7scy7wE3Rhip2XUexQKhvzQJvkkOl__3q-3jCU1j5XCIXH8ANzWwfo8UyPhYfcvI1Kq8WfGw1tWcV8NToqDUA9krfQlFqsz5TIRkBE2ps5ukuI-wqy5UoSlI-MTnhJgMUYUdilqQQKSOofhhX-4_yhk7-0sxfbnsbNx5ny16BJHYJ_jKWtPSdoKdh4hJNJPvKnVxqM7eOyUd1JtkJvr_gAGhpoNInrcsUC_8dXKc5aPCJvkbGItjW5HBMVCXOIoK9y_0xbxYr1iltnl4HtiCpYxX7SRfqpYMMBeFo05AGYZX1wQ45Lq0xzDJ6xbU5-38xgSrXcVwF5A-MZ9nsB_5_zB4ME1xkjCC08B3i4jqdvhIivnMtiLlagnEeX6BTJF_P3jsv-E4i_L9cVKTAbcCvMQic-xSQMW6cqeOlECRH8dgwvCrVAz--nAJAffp0AY-lEvgsPdq9R64K_pA6P7rRpYn_mGSSUw_RXZO85zI5QktHdfii3GJjD__XH2YcguUVOp142nyS_k3ukHX6qD21fniH_X6LOxccoHiixLkAnYtvgJw6_yyhs899j8CIINArs67KNqLbI1Bbg
Accept	application/json

The response shall be similar to this


{
    "success": {
        "id": 8,
        "name": "some.user",
        "email": "some.user@example.cxm",
        "role": "author",
        "receive_notifications": 0,
        "created_at": "2020-01-16 10:00:34",
        "updated_at": "2020-01-16 10:00:34"
    }
}

RefreshToken http://127.0.0.1:8000/api/refresh-token

Method: POST

Headers:

key	value
Accept	application/json

Params (Body->form-data:

key

value

referesh_token

def50200084a769984221cc896b934c1d6c7a21b3746efcf833a1260f6e0a8aed94cc9b1abb590fd4b91b25aec59ab43328c9c6afe906892f710cd8b20a2be34f75df5d10947a49550b6f21ddf7b358843116d9ca07e49289c109eb4fc21ee220d28cb89f70d1f282fe99a67d2481082d244266748e29c5a0f33180b8337db1ade74f52bb7344e69b0da8212c6583cbfe851978e8726f0eb84e0011848e8b67124949d19988150749611b8855109d07007fadcc81c71c9333e93baca907e8f013b93c4c1469a23f7cd041b5b23a3c70ab719ec81e05ebbd0a952abe85e8df5a6bfc3d8af6d0619dfecfe0d849d3ceeb280e3e8e6f4ba2cefe05b739a0619c7808c13765e5a105285b9c572b45df1532ad9dfc03d120e1ec7ba5ac59c868dee53e6bf8acb0d7709858dbcd8783fd616c3e102b37228d7747f620fcc0009b5677960dbcca3f1c767bf07a5e6d07820ffab85754a7264956de59b80745004789659c9

A new access and refresh tokens are issued


{
    "token_type": "Bearer",
    "expires_in": 900,
    "access_token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJhdWQiOiI0IiwianRpIjoiM2Y2M2EwY2ZkZjA0ODQ4YTMzMWIyYzVmMjAzM2ZiMjE4MDE0OGEzY2RmNTQ2MDMwMzRkYWVjMzllYWVjMjk0NjVjZjM0ODE1MTc4ZjJhNWYiLCJpYXQiOjE1ODA1NjY1MTUsIm5iZiI6MTU4MDU2NjUxNSwiZXhwIjoxNTgwNTY3NDE1LCJzdWIiOiI2Iiwic2NvcGVzIjpbXX0.jpDeGTi2rTrkzgG26I5DmB-gMRZdKuIZXIBN3CbJmRoUU859jnK5DZhSILvxAO-gxz_sLIZo-bWTAb0e6Na5AJ8nk8dCkU1OG4a1iM6y2V1IJ0AtscIxvuOtvYDIfZRNHIe9gL8wMGu0kAoUnuknd4glYiFMD7vBXvryaOJu8PWvhq6LVFweLXE5e1lyO3AvEod7ggl4sk3qz-ZgZoJwwMaeD_BJ0GLFUEnvx5vrzVDw0TC5IObDFGA2F4NPwuyWiceH6msH_ey2APwg7jQBl25JQk_AZKmXrsqIs5vUaoTijy6GRlOrB7IWTMN8gqk5N9G9WyCE-UPzjuiPTQnofVcV89oT0ZtRdg8P-dn12vuOl7ySpKAf8GJ4ZLpdwq_RfX6diTsvsTWbQHtztBio5j9u99wcNiGUy5UbqTk72F5hLFsK8gBtprU88ZWY2dmolC59dVKkxBhW2b_pTaU-szSbIkxsJ2dI-xSKqsvEKXGsf_NR4obMzQVCsmCxn9MRSz1pdIo92n-8o5KBfWCbBmvDTWtNjN7j-d7hfi0bS5I1Ec8i2BJsElk5eR6H87ed5VhM4Ww5yBCilnBDDrx3VwgOsnU9SqTvNjvzomlaIgBBn7FsCv-nNOSFxWZSzNc-A97kNscAt5d3_y9XestaXphS2EbET5BnamjIsWEbic8",
    "refresh_token": "def502003b4fb86d8bcb633fbed9de8c6be36ed541c41947094b216e2ce1411df234ee712efcb4e814765c24907b6399100f6f73ee6cd96fc6edc55169b57abd5fe4dcba80a68ed4ca4a77bf15c382e3b618a2d0deec209d1d8cf94aa8026732407edc19a48e9adffdffd1a139ab3f872e912cb41976a5d54a99e61be2aa409e14ed95f047e21896e910ae98c7ee604db7b40fd2036a7b105e2956cad3e6ce705a867bf73005e59fbf095e80d6ad82ac07648fe1e451a4079b7b33410290ce1d828a66596fed86590b887a532ced3cf4513e99f8f74583a44dd6a2a4755f65876589b926d9f9793fa99b4bcc0a7f206cca80ef9ba16e82326c518969c78755d5c5abf27e22548029dbdedbef8804972b5f6ffd2bb166ae688fe3bfe593e6133a3f0324b09dd42af478983284b4fa95401cc99f0de276324af4637d9299f666a89e8c76baa351356ccaed6456d8a6e22bc3803c8420063cdcd16b33a4a0607555d1"
}

If wrong or missing parameters passed then the result is similar to


{
    "error": "invalid_request",
    "error_description": "The refresh token is invalid.",
    "hint": "Token is not linked to client",
    "message": "The refresh token is invalid."
}

BOOKS index http://127.0.0.1:8000/api/books

Method: GET

Headers:

key	value
Accept	application/json
Authorization	Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpc3MiOiJodHRwOlwvXC8xMjcuMC4wLjE6ODAwMFwvYXBpXC9hdXRoXC9yZWZyZXNoIiwiaWF0IjoxNTc0MzM5NTUxLCJleHAiOjE1NzQzNDAxNzIsIm5iZiI6MTU3NDMzOTU3MiwianRpIjoiYkQ1d25VSnhJbGd1c3hzdSIsInN1YiI6MSwicHJ2IjoiODdlMGFmMWVmOWZkMTU4MTJmZGVjOTcxNTNhMTRlMGIwNDc1NDZhYSIsIm5hbSI6IlNvbWV0aGluZyJ9.Mi6Uea92c29VsKlT8r_KTuZulGquSRNFgrGl2-1P9dc

Eventually you can put a query string parameter to set the page you want to receive

Params:

key	value
page	3

The response will be a paginated list by 5 books similar to this


{
    "current_page": 1,
    "data": [
        {
            "id": 1,
            "user_id": 11,
            "category_id": 2,
            "title": "Now I growl.",
            "description": "March Hare had just begun to repeat it, but her voice close to her that she ought not to make out exactly what they WILL do next! As for pulling me.",
            "image": "http://ba2-server.local/api/image/2.jpg",
            "created_at": "2020-01-20 15:19:02",
            "updated_at": "2020-01-20 15:19:02",
            "user": {
                "id": 11,
                "name": "Abdiel Cremin DDS"
            },
            "category": {
                "id": 2,
                "name": "TGPot2Ejot"
            }
        },
        {
            "id": 2,
            "user_id": 11,
            "category_id": 7,
            "title": "Hatter. He.",
            "description": "Dormouse into the roof of the guinea-pigs cheered, and was surprised to find that she wasn't a really good school,' said the Caterpillar. Alice.",
            "image": "http://ba2-server.local/api/image/3.jpg",
            "created_at": "2020-01-20 15:19:02",
            "updated_at": "2020-01-20 15:19:02",
            "user": {
                "id": 11,
                "name": "Abdiel Cremin DDS"
            },
            "category": {
                "id": 7,
                "name": "qjdzPNJTa3"
            }
        },
        {
            "id": 3,
            "user_id": 15,
            "category_id": 8,
            "title": "Alice, 'and.",
            "description": "White Rabbit blew three blasts on the look-out for serpents night and day! Why, I wouldn't be in a sorrowful tone; 'at least there's no use in the.",
            "image": "http://ba2-server.local/api/image/3.jpg",
            "created_at": "2020-01-20 15:19:02",
            "updated_at": "2020-01-20 15:19:02",
            "user": {
                "id": 15,
                "name": "Dolly Rath"
            },
            "category": {
                "id": 8,
                "name": "sAFr7PEh9Z"
            }
        },
        {
            "id": 4,
            "user_id": 11,
            "category_id": 5,
            "title": "Alice. 'I.",
            "description": "King; and the three gardeners, oblong and flat, with their heads!' and the whole head appeared, and then added them up, and there stood the Queen.",
            "image": "http://ba2-server.local/api/image/1.jpg",
            "created_at": "2020-01-20 15:19:02",
            "updated_at": "2020-01-20 15:19:02",
            "user": {
                "id": 11,
                "name": "Abdiel Cremin DDS"
            },
            "category": {
                "id": 5,
                "name": "UnEvAZj7r9"
            }
        },
        {
            "id": 5,
            "user_id": 13,
            "category_id": 2,
            "title": "Hatter. 'Does.",
            "description": "Mock Turtle. 'No, no! The adventures first,' said the Duchess, digging her sharp little chin into Alice's head. 'Is that the Mouse only growled in.",
            "image": "http://ba2-server.local/api/image/4.jpg",
            "created_at": "2020-01-20 15:19:02",
            "updated_at": "2020-01-20 15:19:02",
            "user": {
                "id": 13,
                "name": "Elmira Hodkiewicz"
            },
            "category": {
                "id": 2,
                "name": "TGPot2Ejot"
            }
        }
    ],
    "first_page_url": "http://ba2-server.local/api/books?page=1",
    "from": 1,
    "last_page": 6,
    "last_page_url": "http://ba2-server.local/api/books?page=6",
    "next_page_url": "http://ba2-server.local/api/books?page=2",
    "path": "http://ba2-server.local/api/books",
    "per_page": 5,
    "prev_page_url": null,
    "to": 5,
    "total": 29
}

And if we decide to pass the page parameter like http://127.0.0.1:8000/api/books?page=2 then if the page is one of the valid pages then corresponding information will show otherwise you can see this


{
    "current_page": 7,
    "data": [],
    "first_page_url": "http://127.0.0.1:8000/api/books?page=1",
    "from": null,
    "last_page": 5,
    "last_page_url": "http://127.0.0.1:8000/api/books?page=5",
    "next_page_url": null,
    "path": "http://127.0.0.1:8000/api/books",
    "per_page": 5,
    "prev_page_url": "http://127.0.0.1:8000/api/books?page=6",
    "to": null,
    "total": 21
}

BOOKS publish http://127.0.0.1:8000/api/books/publish

Method: POST

Headers:

key	value
Accept	application/json
Authorization	Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpc3MiOiJodHRwOlwvXC8xMjcuMC4wLjE6ODAwMFwvYXBpXC9hdXRoXC9yZWZyZXNoIiwiaWF0IjoxNTc0MzM5NTUxLCJleHAiOjE1NzQzNDAxNzIsIm5iZiI6MTU3NDMzOTU3MiwianRpIjoiYkQ1d25VSnhJbGd1c3hzdSIsInN1YiI6MSwicHJ2IjoiODdlMGFmMWVmOWZkMTU4MTJmZGVjOTcxNTNhMTRlMGIwNDc1NDZhYSIsIm5hbSI6IlNvbWV0aGluZyJ9.Mi6Uea92c29VsKlT8r_KTuZulGquSRNFgrGl2-1P9dc

Params:

key	value
title	New book title
description	Some long description text
category_id	5
image	data:image/jpg;base64,/9j/4AAQSkZJRgABAQAAAQABAAD/2wCEAAkGBxITEhISEBIWFhASGBcWGBgXFyURIBsWIBUYHR0dHxcdHiosJCYnHR4XITEtJSkrLy4uGiszOD8tRSktMCsBCgoKDg0NGhAQGjclFCUxNzc3Nys3NTAtKzc4ODcrNzctLS4tLTctKzctKywtNy0rMys4LSstLDQrKzgtLSsrL//AABEIAGQAUAMBIgACEQEDEQH/xAAcAAACAgMBAQAAAAAAAAAAAAAABwMGAQQFCAL/xAA9EAACAQIDAwkGBAQHAQAAAAABAgMEEQASIQUGMQcIEyIzQVFzsxcyVHGT0RQjYYEkUpGhQnKiscHh8SX/xAAXAQEBAQEAAAAAAAAAAAAAAAAAAQID/8QAIREBAAIBBAEFAAAAAAAAAAAAAAERAwISIUEiMTJhkaH/2gAMAwEAAhEDEQA/AF5yfbkPtR5kjmWMwqrdZS1wWtbThwxdfYHUfGRfTb74zzbu3rfLj9Q4feAQfsDqPjIvpt98HsDqPjIvpt98Py2AnBSD9gdR8ZF9Nvvg9gdR8ZF9Nvvh4vtKEamaMD/Ov/JxGNsU2ZUFRFnY2VekUknwAvcnAJL2B1HxkX02++D2B1HxkX02++H4MFsAg/YHUfGRfTb74pXKBuQ+y3hSSZZDMpYZVK2swFtfnj1jhB85Ht6Py5PUGAzzbu3rfLj9Q4fZwhObd29b5cfqHD6OAru19+dnU0ogqKuNJjpl1bKfByoIXx61tMS7zzLNs2saErIslLPlKEOGBhYCzDQg+OPM+/8AQPDtStRhdjO7ge9cOxdb+Nwwvix8me8b0au6v0lIWH4mnb+UhQ0ka2sCovcA9ZVIbLZDgjpbP3Q2dLNEOjYxvU0qe+ReObZjT6sLXJl1vxtoLDEuwd36OJqGRYyJ/wD4siHMT+dNPI0pIvYgpHoOA7gLnGxQdU0/uloJaWGRlvYvTitpi1+IJiekb5ODiu7zbXamp6UxtaocUpU8ciw7MijUjwIlnqLEcGjvxGAce8/KVQUTmF2eWoW144F6UqSbAFiQAb6WvfUaa43t1t+KGv0pph0vfE/5cg0ueoeIHeVLAeOPLGy5Srhhe5YWtdTfuKsOD8CptYHXG1NGrsWJCygXupEIzBUJ6rAAWtItwbs9rccB7CGEHzke3o/Lk9QY6XIjvfV1FXNSSzvNTJE8kZl6zi0qKt346q2oJaxAtbW/N5yPb0flyeoMFZ5t3b1vlx+ocPvCE5t3b1vlx+ocPvAhQeUfk4j2iVnjZY6yMZQWBKSKNQrhdRY8CNQCQQ2lkdvDu9UbNfJUxZLnQq11lQplYK4tfib6AqG1Gov6vxyt49gwV0D01SmaN+8aFWHB1buI1+eoIIJBBDb/ANaelptobNd1g2hDfIDfLNF0ayBkII0VYrnvK5r2x80OxIn2HU7Rr5GMskqdASblsjFcg1BszNKGtwCZtbWxyt+dhT7Pl/BTM7UpPSRudRIcmUuoA6pC5UK34qCcwy42thbGrdtfhqaBRFQUaBMxuyqx6zsdbs7MTYCwtbhqcEUaZzx01vcAC17d1tOB4j+2NmhgnqCIKeNndyTkjUsSNDYgaZVNyPC5J/T0xuvyZ7OolNoRNIws0k4Ept4BSMoHHgL24k4tVHQxRAiGNIwe5FCa/JQL4Ci8kW4bbOheSot+LnAzAaiNBqEDDibm7EaXAAva5o3OR7ej8uT1Bh+4QXOR7ej8uT1BgrPNu7et8uP1Dh94QnNu7et8uP1Dh94EDHO25tiGkheoqXCRJxJ7z3ADiSe4f+4g3k3hp6KFp6qTKg4DizH+VV7yfDuGpsLnCBq6qu3jrwiXSnQiy6skMV7Fzwux/YsdBYDQOfvvyhT184ky5aeIkRxHrLYgglx3sw/UAC4HeTYuTnf00DqlQf4CpYtYgB4ZGCkuFGpja41trYkWIKtJyybs01BTbPgpY9P4gs5sWYgQgs7W1491gNABbFgi3HWu2JQSQHLWwwfluDkzqWYtEzaaG7AX90k9xa5DcilDKGUgqwuCDcEEXBBGhBGt8SYQHJfv+aKV6GrV1pcx94EmlcMQytcXCZuP8pN+84fcUgYBlIKkAgg3BBFwQRxGCpRhBc5Ht6Py5PUGH6MILnI9vR+XJ6gwGebd29b5cfqHD3mfKpaxNgTYdY6DgB3nCH5tvb1vlx+ocPzBHnyWuO20EUcZm2pUsRIzqeioaZZARkJ0BYBbnVjcroSAXLuhuvBs+nWCnXwLufed7Wuf9gOAH747UcKqWKqAWNyQLXPiT34kwCR5x8utCt9ctR3Xvd6fQeHD+364YHJO4OyaHj2ZGv6SOP6aG36YqPLLEqVVHUVNJJU0axyoyozJ1yQVBZRoOFtdbHwsbfyW0EsGy6OKdSkioxKnQgNI7LcdxykXB1B00wHG393YeOpTa1DD0s8d1qKcC/4iEqVYAAG7BTaxBuADYlQDPyTT1DR1SyU0tPRJLakSa4dY9SydbUqpy24gZioJy6X7GcFZwgucj29H5cnqDD8GEHzke3o/Lk9QYDW5Bq9IGr5pSQiRwjqguSTKVUBV1JLED9/DDjl3vpkKB+kUsATmiZcgMhjUvcaAuLA9/HhrhN8gggaStSp6MxNHGCJLWNpCRo2mhscORaTZg6Pq0v5Xue51esW08Otdvnrxxmb6dNE468o5+GptTfiFI5miRpHiDMAwaJZFSRY5CshUg5WOthr3aa4263eqJKdqlEkkQS9D1VPWbPlJB4EZri40JFhfA9FswmQlaUmb3z1CWOYNr49YBvnriVxs8pJGfwxjlYvIt0sz6dYi9idBqddBhWpvdh447+4aFHvtAXmSdWiMLzgHWQMkShmbMq6HKb5dSNOJIxLXb2otHLVRRs/QlQUe8B1Ka9ZT/hYMDYg8L3xIKbZobMq0ga7G/Uvdls39RofEYkWPZwiMH8N0BOYpdctxYg2JtpYfKw8MStVLuwXE7ZpBJvrSKtyZAQ0isvRPmUIFLlltoArKb+B07wM1W+NOC6xXkcKxWysqM4iMvR9LlIByWb/vTGXotllBGUpCiksF6hAJtc2/Wwv42GJJYdnM7SOKUyMpUsShJUrlIJvr1er8tOGHkl4L9JatNvzTGBZnDqLJmAUuFdohJkz2AJCkX4akDjphW8483nord8Tn/WMNlqLZhBBWlsQoI6moVCoB11AUlQPA24YUPOFnjaai6JkKrE46hDWGcW4cPljUX2xknHPs/ShwXwYMVyF8F8GDAF8F8GDAF8F8GDAF8BwYMB//2Q==

When the data is correct the result will be


{
    "message": "Resource saved"
}

Else if validation is not passed the result is


{
    "message": "Validation error",
    "data": {
        "title": [
            "The title field is required."
        ],
        "description": [
            "The description field is required."
        ],
        "category_id": [
            "The category id field is required."
        ],
        "image": [
            "The image field is required."
        ]
    }
}

There are other validation messages also for example


{
    "message": "Validation error",
    "data": {
        "title": [
            "The title field is required."
        ],
        "description": [
            "The description field is required."
        ],
        "category_id": [
            "The category id must be a number."
        ],
        "image": [
            "The image field is not a valid base64 image representation."
        ]
    }
}

CATEGORIES list http://127.0.0.1:8000/api/categories

Method: GET

Headers:

key	value
Accept	application/json
Authorization	Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpc3MiOiJodHRwOlwvXC8xMjcuMC4wLjE6ODAwMFwvYXBpXC9hdXRoXC9yZWZyZXNoIiwiaWF0IjoxNTc0MzM5NTUxLCJleHAiOjE1NzQzNDAxNzIsIm5iZiI6MTU3NDMzOTU3MiwianRpIjoiYkQ1d25VSnhJbGd1c3hzdSIsInN1YiI6MSwicHJ2IjoiODdlMGFmMWVmOWZkMTU4MTJmZGVjOTcxNTNhMTRlMGIwNDc1NDZhYSIsIm5hbSI6IlNvbWV0aGluZyJ9.Mi6Uea92c29VsKlT8r_KTuZulGquSRNFgrGl2-1P9dc

When proper token authentication is provided the result will be similar to


{
    "current_page": 1,
    "data": [
        {
            "id": 1,
            "name": "YqK857SFXf",
            "created_at": "2020-01-20 15:19:00",
            "updated_at": "2020-01-20 15:19:00"
        },
        {
            "id": 2,
            "name": "TGPot2Ejot",
            "created_at": "2020-01-20 15:19:01",
            "updated_at": "2020-01-20 15:19:01"
        },
        {
            "id": 3,
            "name": "3QIaiWGJbL",
            "created_at": "2020-01-20 15:19:01",
            "updated_at": "2020-01-20 15:19:01"
        },
        {
            "id": 4,
            "name": "2LPDVpPpZG",
            "created_at": "2020-01-20 15:19:01",
            "updated_at": "2020-01-20 15:19:01"
        },
        {
            "id": 5,
            "name": "UnEvAZj7r9",
            "created_at": "2020-01-20 15:19:01",
            "updated_at": "2020-01-20 15:19:01"
        },
        {
            "id": 6,
            "name": "tYDqaWvCKJ",
            "created_at": "2020-01-20 15:19:01",
            "updated_at": "2020-01-20 15:19:01"
        },
        {
            "id": 7,
            "name": "qjdzPNJTa3",
            "created_at": "2020-01-20 15:19:01",
            "updated_at": "2020-01-20 15:19:01"
        },
        {
            "id": 8,
            "name": "sAFr7PEh9Z",
            "created_at": "2020-01-20 15:19:01",
            "updated_at": "2020-01-20 15:19:01"
        },
        {
            "id": 9,
            "name": "7wB7PXXnUS",
            "created_at": "2020-01-20 15:19:01",
            "updated_at": "2020-01-20 15:19:01"
        },
        {
            "id": 10,
            "name": "oCunZnPwgR",
            "created_at": "2020-01-20 15:19:01",
            "updated_at": "2020-01-20 15:19:01"
        }
    ],
    "first_page_url": "http://ba2-server.local/api/categories?page=1",
    "from": 1,
    "last_page": 1,
    "last_page_url": "http://ba2-server.local/api/categories?page=1",
    "next_page_url": null,
    "path": "http://ba2-server.local/api/categories",
    "per_page": 10,
    "prev_page_url": null,
    "to": 10,
    "total": 10
}

Files

README.md

Latest commit

History

README.md

File metadata and controls

books-api2-server

If you enjoy this API example, please give a star to this repo

Authentication - works for both user and admin

Login

Register

Me

Categories - restricts access for every request to the data

List all (both author and reader)

Create new

Books - restricts access for every request to the data

List all (both author and reader)

Create new (author only)

Show (both author and user)

Update (admin only)

Delete (admin only)

Method: POST

Headers:

Params (Body->form-data):

On success the response shall be similar to this

Since the email has to be unique in the DB, if someone try to register the user with same email, then this error appear

Method: POST

Headers:

Params (Body->form-data):

The response shall be similar to this

If some or both of credentials are wrong or missing, the response will give status of 401 and will be

Method: POST

Headers:

The response shall be similar to this

Method: POST

Headers:

Params (Body->form-data:

A new access and refresh tokens are issued

If wrong or missing parameters passed then the result is similar to

Method: GET

Headers:

Params:

The response will be a paginated list by 5 books similar to this

Method: POST

Headers:

Params:

When the data is correct the result will be

Else if validation is not passed the result is

Method: GET

Headers:

When proper token authentication is provided the result will be similar to