This is the documentation of the Bookstore API service that was created for the Bookstore project.

🔗 Base URL

https://us-central1-bookstore-api-e63c8.cloudfunctions.net/bookstoreApi

🔌 Endpoints

1. /apps/

This endpoint allows the client to create a new app by sending a POST request without any parameters. The server will respond with a unique identifier for the newly created app.

<aside> 🔗 URL example: https://us-central1-bookstore-api-e63c8.cloudfunctions.net/bookstoreApi/apps/

</aside>

Actions Parameters Request Response
POST N/A N/A Unique identifier, i.e. abc123

2. /apps/:app_id/books

This endpoint allows the client to:

<aside> 🔗 URL example: https://us-central1-bookstore-api-e63c8.cloudfunctions.net/bookstoreApi/apps/abc123/books

</aside>

Actions Parameters Request Response
GET app_id (required) N/A A list of items
// Response example
{
    "item1": [
        {
            "title": "The Handmaid's Tale",
            "category": "Fiction"
        }
    ],
    "item2": [
        {
            "title": "Great Expectations",
            "category": "Classics"
        }
    ]
}

<aside> 🔗 URL example: https://us-central1-bookstore-api-e63c8.cloudfunctions.net/bookstoreApi/apps/abc123/books

</aside>

Actions Parameters Request Response
POST app_id (required)
JSON, which includes:
item_id, title, author, category A string
// Response example
Created

3. /apps/:app_id/books/:item_id