Skip to content

valentines-book-list.md

Latest commit

 

History

History
83 lines (57 loc) · 2.35 KB

valentines-book-list.md

File metadata and controls

83 lines (57 loc) · 2.35 KB

Valentine's Book List API

This API allows you to view the books that Valentine has read or plans to read.

The API is available at https://valentines-book-list.glitch.me

Endpoints

Status

GET /status

Returns the status of the API. Example response:

{
    "status": "UP"
}

Status UP indicates that the API is running as expected.

No response or any other response indicates that the API is not functioning correctly.

Books

Get a book list

GET /books/lists

Returns a list of books. Requires authentication.

This endpoint uses pagination to handle the returned results. Paginating the results ensures responses are easier to handle. Each response will indicate the total number of results, the current page, and the total number of pages.

Parameters

Name Type In Required Description
list string query Yes Specifies the list you want to retrieve. Must be one of: favourite-books, non-fiction, wishlist, fiction.
page integer query No Specifies the page you wish to retrive from the entire result set.

Status codes

Status code Description
200 OK Indicates a successful response.
400 Bad Request Indicates that the parameters provided are invalid.

Example response:

{
    "status": "OK",
    "num_results": 17,
    "page": 1,
    "total_pages": 4,
    "results": [
        {
            "title": "Crush It!: Why NOW Is the Time to Cash In on Your Passion",
            "category": [
                "non-fiction"
            ],
            "type": "audio",
            "author": "Gary Vaynerchuk",
            "release_year": 2010,
            "rating": "7"
        },
        ...
    ]
]

API Authentication

Some endpoints require authentication.

The endpoints that require authentication expect the API key to be provided as a query parameter named api-key.