iO Academipsum RESTful API

Live demo - https://api.2022-academipsum.dev.io-academy.uk/ipsum

Run the API locally

Clone this repo into your docker `html` folder:

git clone [email protected]:iO-Academy/2022-jan-ipsum-be.git

Once cloned, first install the database stored in the project root. Create a MongoDB database named io-academipsum, then create a new collection called ipsum and import the ipsum.json file.

To run the application locally, cd into the root directory and run the following commands:

npm i

npm start

Do not close this terminal tab, it is a running process.

The API will now be accessible at http://localhost:3002/.

That's it! Now install the front end and have fun.

API documentation

This API only supports GET requests.

Bad requests will return the following error:

{
  "success": false,
  "message": "Bad request- method not allowed",
  "status": 200,
  "data": []
}

Return paragraphs of ipsum text

• URL

  /ipsum

• Method:

  GET

• URL Params

  Required:

  There are no required URL Params, this URL will return a single paragraph if no params are passed.

  Optional:

  paragraphs=[integer] - The number of randomly generated paragraphs to return.

  • Parameter value must be in the range of 1 to 10, or the following error will be returned:

    {
    "success": false,
    "message": "Please pick a number between 1 and 10",
    "status": 200,
    "data": []
    }

  Example:

  /ipsum?paragraphs=4

• Success Response:

  • Content:
    

  {
    "success": true,
    "message": "Success- results found",
    "status": 200,
    "data": [
        "Definition of Done undefined, array Charlie Ethan Jordan git fetch the shadow DOM Grace git stash pop. Jordan Agile Aardvarks Foxy Ferrets Charlie Product Owner OhMyZsh Hyper Lynx Norbert Fried Egg Jellyfish MongoDB. Boolean React komodo dragon on a skateboard (not blind) git checkout Valkyrie SWGOL undefined Sophie Dr Jean Grey. Response Dino Finder Chi-Ca-Go Dung Beetles Hello World! response Hello World! T-Shaped Profiles motivational poem playing with Lego. Ethan hard refresh Raurie Royal Penguins Batman do the thing mkdir mouse komodo dragon on a skateboard (not blind) rubber ducking Sprint Review. Dr Jean Grey LAMP Grace Dr Jean Grey Geckos The Agile Manifesto, Barry Chi-Ca-Go Larry. Gitignore conditional rendering nodes motivational poem trial by paper Fighting Mongooses request terminal Raurie repo. "
    ]
  }

• Error Response:

  • Content:
    

  {
    "success": false,
    "message": "Something went wrong- No results",
    "status": 200,
    "data": []
  }

---

• Example call:

const getIpsumData = async () => {
    const response = await fetch('http://localhost:3002/ipsum')
    let result = await response.json()

    return result.data
}

Example Projects

React Lorem Ipsum Generator - https://github.com/iO-Academy/2022-jan-ipsum-fe

Authors

Ethan Garrett - @EthanGarrett

Grace Palacz - @Grace-P-03

Jordan Addis - @J-Add

Marcus Drury - @Marcus12934