QuoteGarden

A RESTful API for quotes. The database currently includes more than 75000 quotes.

View the Project on GitHub pprathameshmore/QuoteGarden

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/quotegardennpm@1.1.0

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


#### Response

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

Get all genres

Returns all genres from the database.

Request


#### Response
```javascript
{
  statusCode : int,
  genres : array
}

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. ```