Coder Social home page Coder Social logo

books-api's Introduction

books-api

Digital Publishing Books API

Getting started

Swagger specification

Pre-requisites

Install and run a mongoDB

  • Using homebrew:
    • brew install mongodb
    • If not automatically started, use brew services start mongodb
    • Stop mongoDB by running brew services stop mongodb

Other Dependencies

  • No further dependencies other than those defined in go.mod

Running the Application and unit tests

  • Run application with make debug
  • Run unit test with make test

Configuration

Environment variable Default Description
BIND_ADDR :8080 The host and port to bind to
GRACEFUL_SHUTDOWN_TIMEOUT 5s The graceful shutdown timeout in seconds (time.Duration format)
HEALTHCHECK_INTERVAL 30s Time between self-healthchecks (time.Duration format)
HEALTHCHECK_CRITICAL_TIMEOUT 90s Time to wait until an unhealthy dependent propagates its state to make this app unhealthy (time.Duration format)
MONGODB_BIND_ADDR localhost:27017 The MongoDB bind address
MONGODB_BOOKS_COLLECTION books The MongoDB books collection
MONGODB_REVIEWS_COLLECTION reviews The MongoDB reviews collection
MONGODB_DATABASE bookStore MongoDB database
DEFAULT_MAXIMUM_LIMIT 1000 Pagination: maximum number of items returned
DEFAULT_LIMIT 20 Pagination: default number of items returned
DEFAULT_OFFSET 0 Pagination: default number of documents into the full list that a response starts at

Electronic Library Design

See ARCHITECTURE Source of truth for processing of book data for search.

Contributing

See CONTRIBUTING for details.

License

Copyright © 2020 - 2021 Catalina Garcia

Released under MIT license, see LICENSE for details.

books-api's People

Contributors

cadmiumcat avatar eldeal avatar nshumoogum avatar

Forkers

onsdigital

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.