Giter VIP home page Giter VIP logo

bookshelf-server's Introduction

codebeat badge Build Status

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

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.

bookshelf-server's People

Contributors

emenegro avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.