/word-api

Primary LanguageJavaScript

word-api

This API is for use with the Art Block repo. This API is hosted on Heroku. Only GET is currently supported.

Installation and Set-Up

If you want to run locally complete the following:

1. Clone down this Repository using `git clone`
2. Next, `cd` into the cloned repository and `npm install` to install library dependancies
3. Finally, run `npm start` to activate the local server.

Endpoints

To get all words:

https://art-block-word-api.herokuapp.com/api/v1/words

To retrieve a word by id:

https://art-block-word-api.herokuapp.com/api/v1/words/id/:id

To get a random word:

https://art-block-word-api.herokuapp.com/api/v1/words/random

Tech Stack

  • Heroku
  • NodeJS
  • ExpressJS

Collaborators