well-read-service
Well-Read Service: API documentation for a fantasy book recommendation service
Welcome to the REST API of Well-Read, a simple service where you can receive book recommendations from an extensive collection of fantasy novels based on personas crafted with different reader preferences.
Use this API to learn how to install the service in your system, add books to the collection, get book recommendations based on reader personas, and refine reader personas to get better book recommendations.
To help you receive more accurate book recommendations, you can take the Well-Read Persona Quiz to determine which reader persona fits you the best. The quiz comprises of 6 personality-based multiple choice questions and takes approximately 5 minutes to complete.
| Quick links | ||||
|---|---|---|---|---|
| Service prerequisites | Quickstart tutorial | Tutorials | API reference | About the service |
Service prerequisites
Before you can run the Well-Read Service, you need to have the following apps and files in your system:
- The database file for the service
- Version 0.17.0 of the JSON server or later
- The Postman desktop app
- A command-line tool
Follow the instructions in the Service prerequisites page to ensure that you have all you need to run the service properly.
Get started with a quickstart tutorial
Let’s dive right into the Well-Read Service with a quick tutorial to get book recommendations based on specific properties of a reader persona. Make sure you have all the service prerequisites in your development system and 20 minutes to take the tutorial before you begin.
Access the quickstart tutorial here.
Tutorials
After you’ve successfully received your first book recommendation, you can take a look at more tutorials for things you can do in the service:
- Find your reader persona
- Update a reader persona
- Add a book to the collection
- Find books by subgenre
API reference
The
{base_url}value of the resources depends on the installation of the service.When run locally for testing, the
{base_url}is generallyhttp://localhost:3000.
Resources and reference topics for the service
About the service
Fantasy is a far-reaching genre with a variation of subgenres that are ever-expanding. The Well-Read Service provides you with book recommendations based on the reader persona with which you identify most. The service suggests novels based on pace, topics covered, and themes. Use the Well-Read Service to discover a variety of niche books that complement your reading style.