Reading List API
The Reading List API lets you keep a personal catalog of books and track your progress through each one. You can add a book, look one up by its ID, and list your books filtered by reading status.
This is a fictional API
The Reading List API is a sample designed for this portfolio. It has no production backend. You can run every example in these docs against a local mock server built from the OpenAPI specification.
Who this is for
Developers who want to build a reading tracker, a book-recommendation tool, or any app that needs a simple list of books with a status attached to each one.
What you can do
| Method | Path | What it does |
|---|---|---|
GET |
/books |
List books, optionally filtered by reading status |
GET |
/books/{bookId} |
Get a single book by its ID |
POST |
/books |
Add a book to your reading list |
Every request is authenticated with an API key sent in the X-API-Key header, and every error uses the same Problem Details format.
Start here
- Quickstart: start a local mock server and make your first three requests.
- Authentication: how the API key works and how to keep it safe.
- Error handling: what each error response means and how to fix it.
- API reference: every endpoint, parameter, and response, generated from the OpenAPI specification.
About this sample
This documentation set follows an OpenAPI-first workflow: the OpenAPI 3.1 specification is the source of truth, and the reference is generated from it. The getting-started, authentication, and error-handling guides are written by hand. Process and tooling explains key decisions and the mock server’s limitations. See the changelog for version history or the project overview for the sample’s audience, goals, and writing considerations.