X-Library API Docs (0.0.1)

Download OpenAPI specification:Download

Library API for book management

X-Library Source Code

Authentication

Creates a new user

Request Body schema: application/json

object

Responses

Request samples

Payload

Content type

application/json

{"user": {"email": "string",
"password": "string"
}
}

Response samples

201

Content type

application/json

{"email": "string",
"token": "string"
}

Logs the user in

Request Body schema: application/json

object

Responses

Request samples

Payload

Content type

application/json

{"user": {"email": "string",
"password": "string"
}
}

Response samples

201

Content type

application/json

{"email": "string",
"token": "string"
}

Deletes current session

Authorizations:

bearerAuth

Responses

Response samples

200

Content type

application/json

{"success": true
}

Books

Returns all books.

Authorizations:

bearerAuth

query Parameters

page	number Pagination index
page_size	number Number of resources in a single page

Responses

Response samples

200

Content type

application/json

{"data": {"id": "string",
"title": "string",
"rating": 0,
"price": 0,
"isbn": "string",
"description": "string",
"authors": ["string"
],
"read_by": [{"id": "string",
"email": "string",
"books_read": { },
"reviews": {"id": "string",
"content": "string",
"rating": 0,
"book_id": "string",
"user_id": "string"
}
}
],
"reviews": [{"id": "string",
"content": "string",
"rating": 0,
"book_id": "string",
"user_id": "string"
}
]
},
"pagination": {"page_number": 0,
"page_size": 0,
"total_entries": 0,
"total_pages": 0
}
}

Create a new book

Authorizations:

bearerAuth

Request Body schema: application/json

object

Responses

Request samples

Payload

Content type

application/json

{"book": {"title": "string",
"price": 0,
"isbn": "string",
"description": "string",
"authors": ["string"
]
}
}

Response samples

200

Content type

application/json

{"data": {"id": "string",
"title": "string",
"rating": 0,
"price": 0,
"isbn": "string",
"description": "string",
"authors": ["string"
],
"read_by": [{"id": "string",
"email": "string",
"books_read": { },
"reviews": {"id": "string",
"content": "string",
"rating": 0,
"book_id": "string",
"user_id": "string"
}
}
],
"reviews": [{"id": "string",
"content": "string",
"rating": 0,
"book_id": "string",
"user_id": "string"
}
]
}
}

Create a new book from ISBN number

Authorizations:

bearerAuth

path Parameters

isbn

required

string

ISBN number of the book

Responses

Response samples

200

Content type

application/json

{"data": {"id": "string",
"title": "string",
"rating": 0,
"price": 0,
"isbn": "string",
"description": "string",
"authors": ["string"
],
"read_by": [{"id": "string",
"email": "string",
"books_read": { },
"reviews": {"id": "string",
"content": "string",
"rating": 0,
"book_id": "string",
"user_id": "string"
}
}
],
"reviews": [{"id": "string",
"content": "string",
"rating": 0,
"book_id": "string",
"user_id": "string"
}
]
}
}

Get a single book

Authorizations:

bearerAuth

path Parameters

id

required

string

ID of the book

Responses

Response samples

200

Content type

application/json

{"data": {"id": "string",
"title": "string",
"rating": 0,
"price": 0,
"isbn": "string",
"description": "string",
"authors": ["string"
],
"read_by": [{"id": "string",
"email": "string",
"books_read": { },
"reviews": {"id": "string",
"content": "string",
"rating": 0,
"book_id": "string",
"user_id": "string"
}
}
],
"reviews": [{"id": "string",
"content": "string",
"rating": 0,
"book_id": "string",
"user_id": "string"
}
]
}
}

Update a single book

Authorizations:

bearerAuth

path Parameters

id

required

string

ID of the book

Request Body schema: application/json

object

Responses

Request samples

Payload

Content type

application/json

{"book": {"title": "string",
"price": 0,
"isbn": "string",
"description": "string",
"authors": ["string"
]
}
}

Response samples

200

Content type

application/json

{"data": {"id": "string",
"title": "string",
"rating": 0,
"price": 0,
"isbn": "string",
"description": "string",
"authors": ["string"
],
"read_by": [{"id": "string",
"email": "string",
"books_read": { },
"reviews": {"id": "string",
"content": "string",
"rating": 0,
"book_id": "string",
"user_id": "string"
}
}
],
"reviews": [{"id": "string",
"content": "string",
"rating": 0,
"book_id": "string",
"user_id": "string"
}
]
}
}

Update a single book

Authorizations:

bearerAuth

path Parameters

id

required

string

ID of the book

Request Body schema: application/json

object

Responses

Request samples

Payload

Content type

application/json

{"book": {"title": "string",
"price": 0,
"isbn": "string",
"description": "string",
"authors": ["string"
]
}
}

Response samples

200

Content type

application/json

{"data": {"id": "string",
"title": "string",
"rating": 0,
"price": 0,
"isbn": "string",
"description": "string",
"authors": ["string"
],
"read_by": [{"id": "string",
"email": "string",
"books_read": { },
"reviews": {"id": "string",
"content": "string",
"rating": 0,
"book_id": "string",
"user_id": "string"
}
}
],
"reviews": [{"id": "string",
"content": "string",
"rating": 0,
"book_id": "string",
"user_id": "string"
}
]
}
}

Delete a book

Authorizations:

bearerAuth

path Parameters

id

required

string

ID of the book

Responses

Mark book as read

Authorizations:

bearerAuth

path Parameters

id

required

string

ID of the book

Responses

Response samples

200

Content type

application/json

{"data": {"id": "string",
"title": "string",
"rating": 0,
"price": 0,
"isbn": "string",
"description": "string",
"authors": ["string"
],
"read_by": [{"id": "string",
"email": "string",
"books_read": { },
"reviews": {"id": "string",
"content": "string",
"rating": 0,
"book_id": "string",
"user_id": "string"
}
}
],
"reviews": [{"id": "string",
"content": "string",
"rating": 0,
"book_id": "string",
"user_id": "string"
}
]
}
}

Add a review for a book

Authorizations:

bearerAuth

path Parameters

id

required

string

ID of the book

Request Body schema: application/json

object (review)

Responses

Request samples

Payload

Content type

application/json

{"review": {"id": "string",
"content": "string",
"rating": 0,
"book_id": "string",
"user_id": "string"
}
}

Response samples

201

Content type

application/json

{"data": {"id": "string",
"title": "string",
"rating": 0,
"price": 0,
"isbn": "string",
"description": "string",
"authors": ["string"
],
"read_by": [{"id": "string",
"email": "string",
"books_read": { },
"reviews": {"id": "string",
"content": "string",
"rating": 0,
"book_id": "string",
"user_id": "string"
}
}
],
"reviews": [{"id": "string",
"content": "string",
"rating": 0,
"book_id": "string",
"user_id": "string"
}
]
}
}

Remove a review for a book

Authorizations:

bearerAuth

path Parameters

book_id required	string ID of the book
review_id required	string ID of the review

Responses

Library

Mark book as read

Authorizations:

bearerAuth

path Parameters

id

required

string

ID of the book

Responses

Response samples

200

Content type

application/json

{"data": {"id": "string",
"title": "string",
"rating": 0,
"price": 0,
"isbn": "string",
"description": "string",
"authors": ["string"
],
"read_by": [{"id": "string",
"email": "string",
"books_read": { },
"reviews": {"id": "string",
"content": "string",
"rating": 0,
"book_id": "string",
"user_id": "string"
}
}
],
"reviews": [{"id": "string",
"content": "string",
"rating": 0,
"book_id": "string",
"user_id": "string"
}
]
}
}

Add a review for a book

Authorizations:

bearerAuth

path Parameters

id

required

string

ID of the book

Request Body schema: application/json

object (review)

Responses

Request samples

Payload

Content type

application/json

{"review": {"id": "string",
"content": "string",
"rating": 0,
"book_id": "string",
"user_id": "string"
}
}

Response samples

201

Content type

application/json

{"data": {"id": "string",
"title": "string",
"rating": 0,
"price": 0,
"isbn": "string",
"description": "string",
"authors": ["string"
],
"read_by": [{"id": "string",
"email": "string",
"books_read": { },
"reviews": {"id": "string",
"content": "string",
"rating": 0,
"book_id": "string",
"user_id": "string"
}
}
],
"reviews": [{"id": "string",
"content": "string",
"rating": 0,
"book_id": "string",
"user_id": "string"
}
]
}
}

Remove a review for a book

Authorizations:

bearerAuth

path Parameters

book_id required	string ID of the book
review_id required	string ID of the review

Responses

Lists all reviews of the currently signed in user

Authorizations:

bearerAuth

Responses

Response samples

200

Content type

application/json

{"data": [{"id": "string",
"content": "string",
"rating": 0,
"book_id": "string",
"user_id": "string"
}
]
}

Lists all reviews of the specified user

path Parameters

id

required

string

ID of the user

Responses

Response samples

200

Content type

application/json

{"data": [{"id": "string",
"content": "string",
"rating": 0,
"book_id": "string",
"user_id": "string"
}
]
}

Get the Profile of the given User

Authorizations:

bearerAuth

path Parameters

id

required

string

ID of the user

Responses

Response samples

200

Content type

application/json

{"id": "string",
"email": "string",
"books_read": {"id": "string",
"title": "string",
"rating": 0,
"price": 0,
"isbn": "string",
"description": "string",
"authors": ["string"
],
"read_by": [{ }
],
"reviews": [{"id": "string",
"content": "string",
"rating": 0,
"book_id": "string",
"user_id": "string"
}
]
},
"reviews": {"id": "string",
"content": "string",
"rating": 0,
"book_id": "string",
"user_id": "string"
}
}

Get the Profile of the currently signed in user

Authorizations:

bearerAuth

Responses

Response samples

200

Content type

application/json

{"id": "string",
"email": "string",
"books_read": {"id": "string",
"title": "string",
"rating": 0,
"price": 0,
"isbn": "string",
"description": "string",
"authors": ["string"
],
"read_by": [{ }
],
"reviews": [{"id": "string",
"content": "string",
"rating": 0,
"book_id": "string",
"user_id": "string"
}
]
},
"reviews": {"id": "string",
"content": "string",
"rating": 0,
"book_id": "string",
"user_id": "string"
}
}