Download OpenAPI specification:
API for managing a book collection database with authors, publishers, series, genres, and labels
Retrieve books from the collection with optional filtering by author, title, publisher, or series, plus sorting and pagination support
author | string Filter books by author name (partial match) |
title | string Filter books by title (partial match) |
publisher | string Filter books by publisher name (partial match) |
serie | string Filter books by series name (partial match) |
sortBy | string Enum: "title" "author" "publisher" "release" "serie" Field to sort by |
orderDesc | string Value: "desc" Sort order (desc for descending, otherwise ascending) |
itemsPerPage | integer >= 1 Number of items per page for pagination |
page | integer >= 1 Page number for pagination (starts from 1) |
{- "status": "success",
- "count": 0,
- "books": [
- {
- "title": "The Great Gatsby",
- "authors": "F. Scott Fitzgerald",
- "publisher": "Scribner",
- "release_date": "1925-04-10",
- "series_name": null
}
]
}
Add a new book with all its associated metadata
title required | string Book title |
authors | Array of strings List of author names |
publisher | string Publisher name |
release_date | string <date> Book release date |
series | string Series name |
genres | Array of strings List of genre names |
labels | Array of strings List of label names |
{- "title": "The Great Gatsby",
- "authors": [
- "F. Scott Fitzgerald"
], - "publisher": "Scribner",
- "release_date": "1925-04-10",
- "series": "Classic Literature",
- "genres": [
- "Fiction",
- "Classic"
], - "labels": [
- "American Literature",
- "Jazz Age"
]
}
{- "error": "Database connection failed"
}
Add a new publisher to the database
name required | string Publisher name |
{- "name": "Penguin Random House"
}
{- "message": "Publisher added successfully"
}
Add a new series to the database
name required | string Series name |
{- "name": "The Lord of the Rings"
}
{- "message": "Series added successfully"
}