Giter VIP home page Giter VIP logo

quotegarden's Introduction

Icon

Quote Garden

A REST API for quotes.

I originally built this for Achieve Chrome Extension project and decided to publish for others to use as well. The database currently includes more than 75000 quotes

Build Maintenance GitHub top language GitHub GitHub last commit

Install NPM package

npm install @pprathameshmore/[email protected]

Documentation for NPM package

Table of Contents

API Documentation

The older version of API is now deprecating soon. Please upgrade to new version 2 (V2) API routes for improved performance.

Get a random quote

Returns a single random quote from the database.

Request

https://quote-garden.herokuapp.com/api/v2/quotes/random

Response

{
  statusCode : int,
  {
    _id: string,
    quoteText: string,
    quoteAuthor: string
  }
}

Get quotes by author

Returns multiple quotes for a particular author.

Request

https://quote-garden.herokuapp.com/api/v2/authors/:authorName?page=1&limit=10

Query parameters are optional

Response

{
  statusCode : int,
  message : String,
  totalPages : int,
  currentPage : int,
  quotes : array
}

Get quotes by Genre

Returns multiple quotes for a particular genre.

Request

https://quote-garden.herokuapp.com/api/v2/genres/:genreName?page=1&limit=10

Query parameters are optional

Response

{
  statusCode : int,
  message : String,
  totalPages : int,
  currentPage : int,
  quotes : array
}

Get all quotes

Returns all quotes from the database.

Request

https://quote-garden.herokuapp.com/api/v2/quotes?page=1&limit=10

Response

{
  statusCode : int,
  message :  String,
  totalPages : int,
  currentPage : int,
  quotes : array
}

Get all quotes by keyword

Returns all quotes with matching keywords.

Request

https://quote-garden.herokuapp.com/api/v2/quotes/:searchQuery?page=1&limit=10

Response

{
  statusCode : int,
  message : String,
  totalPages : int,
  currentPage : int,
  quotes : array
}

Get all genres

Returns all genres from the database.

Request

https://quote-garden.herokuapp.com/api/v2/genres

Response

{
  statusCode : int,
  genres : array
}

Get featured

If you are using my API in your application, get featured here. Make an issue with your application.

Contributing

All feedback and contributions are welcome!

License

The MIT License (MIT)
=====================

Copyright © 2019 Prathamesh More

Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation
files (the “Software”), to deal in the Software without
restriction, including without limitation the rights to use,
copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the
Software is furnished to do so, subject to the following
conditions:

The above copyright notice and this permission notice shall be
included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND,
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
OTHER DEALINGS IN THE SOFTWARE. ```

quotegarden's People

Contributors

pprathameshmore avatar dependabot[bot] avatar soub4i avatar cbedoy avatar masnormen avatar shankhanil avatar chikaldirick avatar yuvraj88 avatar

Watchers

James Cloos 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.