emenegro / bookshelf-server

Example app to learn Node.js and MongoDB. A very simple REST API to manage a bookshelf.

Example app to learn Node.js and MongoDB. A very simple REST API to manage a bookshelf.

Authentication

In this first version there is no authentication.

Endpoints

• GET search
• GET books
• POST books
• GET books/[id]
• PUT books/[id]
• DELETE books/[id]

Search

Executes a search against Google Books API and returns the results.

curl -X GET "http://127.0.0.1:8080/search?q=[QUERY]" \
     -H "Content-Type: text/plain"

List books

Lists all the books in the user's collection.

curl -X GET "http://127.0.0.1:8080/books" \
     -H "Content-Type: text/plain"

Create book

Adds a book to the user's collection.

curl -X POST "http://127.0.0.1:8080/books" \
     -H "Content-Type: application/json" \
     --data-raw "$JSON_BODY"

Get book

Gets a book from the user's collection.

curl -X GET "http://127.0.0.1:8080/books/[BOOK_ID]" \

Update book

Updates a book of the user's collection. Used to mark isRead flag.

curl -X PUT "http://127.0.0.1:8080/books/[BOOK_ID]" \
     -H "Content-Type: application/json" \
     --data-raw "$JSON_BODY"

Delete book

Deletes a book from the user's collection.

curl -X DELETE "http://127.0.0.1:8080/books/[BOOK_ID]" \
     -H "Content-Type: text/plain"

Installation

Use docker-compose in order to install the whole app and its dependencies.

Run docker-compose build and docker-compose up -d in the project's root folder and, if everything is OK you could test the API in http://127.0.0.1:8080.

Inside etc/ folder there are both Paw and Postman collections with some prefilled data to play with.

ToDo

• Add user authentication.