Skip to content

Latest commit

 

History

History
35 lines (25 loc) · 981 Bytes

README.md

File metadata and controls

35 lines (25 loc) · 981 Bytes

InspireAPI

A project to learn Javascript, NodeJS and ExpressJS by creating an API that sends out motivational quotes. Released under an MIT licence.

Currently, all requests are made to a single endpoint api/inspire/quotes.

The following requests are supported -

GET

GET /quotes

{
  "id":(a unique integer),
  "quote":(quote text),
  "author":(author or attributed to)
}

For example -

{
  "id":49095,
  "quote":"Crave for a thing, you will get it. Renounce the craving, the object will follow you by itself.",
  "author":"Swami Sivananda"
}

GET /quotes/:id

  • returns a quote corresponding to the quote ID entered in as a parameter (the "id" field in the json output above).

The request types POST, PUT and DELETE are not yet finished and should be avoided.