Skip to content

Latest commit

 

History

History
28 lines (17 loc) · 1.45 KB

README.md

File metadata and controls

28 lines (17 loc) · 1.45 KB

words-api

Note The api is now hosted on https://random-word-form.repl.co. The original heroku link will be taken down remains at https://random-word-form.herokuapp.com/.

A random word form generator. Generates a random noun, adjective, or animal via a GET request. Live at https://random-word-form.herokuapp.com/

Runs on the Heroku eco tier, so upon making a request, it may take a couple of seconds for the dyno to wake up.

Inspired by https://random-word-api.herokuapp.com, a random word generator.

Usage

Send a GET request to the following to generate a random...

To generate a word starting with a specific letter, append /letter to the above urls.

Sample call: /random/noun/a

To get a certain number of words, append ?count=N to the above urls. A maximum of 15000 words can be requested.

Sample calls: /random/noun/a?count=3, /random/noun?count=5

While functional, the site is a work in progress.

Written in Node.js with the Express.js library.