Skip to content

Latest commit

 

History

History
133 lines (99 loc) · 3.25 KB

README.md

File metadata and controls

133 lines (99 loc) · 3.25 KB
Raw

geek-quote-api logo

geek-quote-api

An API for retrieving random geeky quotes

Apps built on geek-quote-api

Production host

🚨 Update 2023!

The production host which was initially hosted on heroku was moved to vercel due to the fact that heroku no longer supports free tier.

The Access-Control-Allow-Origin header is set to * so that you can make requests from any domain.

APIs

GET /v1/quote

Returns an object with one quote:

{
  "quote":"Microsoft: You’ve got questions. We’ve got dancing paperclips.",
  "author":"Unknown Author"
}

GET /v1/quotes/

Returns an array of all quotes

[
 {
  "quote":"There is no place like 127.0.0.1",
  "author": "Unknown Author",
 },
 {
  "quote":"Girls are like Internet Domain names; the ones I like are already taken.",
  "author": "Unknown Author",
 },
]

GET /v1/quote/<count> e.g GET /v1/quote/4

Returns an array of the number of quotes specified

[
 {
  "quote":"Girls are like Internet Domain names; the ones I like are already taken.",
  "author": "Unknown Author",
 },
 {"quote":"Never argue with the data.",
 "author":"Unknown Author"
 },
 {
 "quote":"Passwords are like underwear. You shouldn’t leave them out where people can see them. You should change them regularly. And you shouldn’t loan them out to strangers.","author":"Unknown Author"
 },
 {
 "quote":"JUST SHUT UP AND REBOOT!!",
 "author":"Unknown Author"
 }
]

GET /v1/quote/filter/known

Returns a ramdom object with quote of known author:

{
  "quote": "Every SQL statement that Chuck Norris codes has an implicit 'COMMIT' in its end.",
  "author": "Some Author"
}

GET /v1/quote/filter/known/<count> e.g GET /v1/quote/filter/known/1

Returns an array of number of quotes of known author:

{
  "quote": "Every SQL statement that Chuck Norris codes has an implicit 'COMMIT' in its end.",
  "author": "Some Author"
}

GET /v1/quote/filter/{{keyword}} e.g GET /v1/quote/filter/code

Returns an object with first quote with the searched keyword:

{
  "quote": "Every SQL statement that Chuck Norris codes has an implicit 'COMMIT' in its end.",
  "author": "Unknown Author"
}

GET /v1/quote/filter/all/{{keyword}} e.g GET /v1/quote/filter/all/code

Returns an array with all quotes with the searched keyword:

[
  {
    "quote": "Every SQL statement that Chuck Norris codes has an implicit 'COMMIT' in its end.",
    "author": "Unknown Author"
  },
  {
    "quote": "Talk is cheap. Show me the code.",
    "author": "Linus Torwards"
  }
]

Local development

Once you've cloned this repo, run npm install to install the dependencies.

Then you can run:

  • npm start: runs the compiled server
  • npm run serve: runs the server with hot code replacement

Context

https://www.youtube.com/watch?v=zEsAf88zpg4