README.md

SunTzuAPI

An API that provides you with Sun Tzu quotes

Acknowledgements

• sun-tzu-quotes - The main library used in making of this API

Authors

• @OneByteGH

API Reference

Get All Quotes

  GET /quotes

Returns an array of all the quotes

Get Quote By Id

  GET /quote/${id}

Parameter	Type	Description
id	string	Required. Id of quote to fetch

Returns 200 and the quote of that ID if the ID is valid
Returns 404 if the ID is invalid

Get Random Quote

  GET /quote

Returns a random quote

Also, dont forget to checkout the Swagger Documentation

Run Locally

Clone the project

  git clone https://github.com/OneByteGH/SunTzuAPI

Go to the project directory

  cd SunTzuAPI

Install dependencies

  npm install

Start the server

  node index.js