CPNT 262 Assignment 5 - Deployed REST API

In the assignment you will:

• Create static web pages for your API Documentation (index.html) and custom 404 page (404.html).

• Serve JSON endpoints using app.get() and a Mongoose Model. For example:

  GET /api/animals
  GET /api/animals/:id
  

  • Note: You will be creating your own endpoints not based on animals (unless you want to)

• Besides the public documentation and 404 page, there will be no frontend component to this assignment.

Criteria

4 points will be given for each of the following criteria, for a total of 20 points:

1. Server setup

• Project directory structure:

  project-root
  └─ models
     ├─ seeds
       └─ items.js
     └─ Item.js (change name to match your data)    
  └─ public
     ├─ assets
       ├─ css
       └─ images
     ├─ 404.html
     └─ index.html
  └─ routes
     └─ api.js
  ├─ package-lock.json
  ├─ package.json
  └─ server.js
  

  You may add more but they will not be marked.

• server.js

  • Load the following packages:
    • express
    • mongoose
    • dotenv
    • local module containing your routes (see below);

• App connects to MongoDB Atlas

• App deployed to Heroku and MongoDB Atlas.

  • Connect your Heroku App to the Github repo of your project.
  • "start": "node server.js" defined as a script in package.json
  • Server PORT: If process.env.PORT isn't found, use port 3000.
  • Heroku connected to MongoDB Atlas:
    • Connection string added to Config Vars in Heroku Settings

2. List and item endpoints

Using your gallery from Assignment 2 (modifications are welcome), create a JSON API endpoint that returns a list of gallery items (animals used an example; modify your endpoint to match your content):

GET /api/animals
GET /api/animals/:id

• Routes are loaded as a local module using require('./routes/api.js')
• Data is served from MongoDB using a mongoose model (see below)
• Error handling is implemented:

  • requests to non-existent endpoints to GET /api return a JSON response with 404 status code:

    {
      "error": "404 Not Found"
    }

  • Example endpoints that should return 404 as JSON:

    • GET /api/whatever
    • GET /api/this/endpoint/does/not/exist
    • GET /api/animals/0 (assuming that id does not exist)
    • GET /api/animals/233740055837 (assuming that id does not exist)
• You may choose a parameter other than :id that suits your API.
• Note: Data may come from a local module if mongoose model is inoperable or non-existent.

3. Mongoose Model

• Migrate your frontend Javascript array to a mongoose model (./models/Item.js; rename to suit your data).
  • Basic model properties:
    • id - Unique identifier (Number);
    • title - Image heading (String);
    • description - Image description (String: 10-25 words);
  • Additional properties:
    • An image with:
      • information for the src attribute (String), such as file name or complete path
      • API should output a complete URL (with domain) to a hosted image. This can be local or somewhere else on the Interwebs (like a GH Pages repo).
      • Note: width and height are not needed for this assignment
• Model is loaded using require('./models/Item.js') and used to serve data to your List and Item endpoints.
• Include a ./model/seeds directory containing the data you've imported into MongoDB Atlas.

4. Public documentation and custom 404 page

• Custom 404 html page
  • When requesting a non-existent HTML file (i.e. one NOT at GET /api the user should be redirected to a 404.html or /404 url or similar.
  • File must include a 404 response code.
  • Page must be a valid HTML page.
  • Example 404 requests:
    • GET /whatever/
    • GET /no-file.html
• Serve static assets from a public directory using express.static() middleware.
  • include a static index.html page that documents your API endpoints.

5. Documentation and Code Quality

• Include a README.md in your project that contains the following information:
  • Course title;
  • Author name;
  • Links to:
    • your GH repo;
    • your deployed Heroku domain;
  • Any comments that may help squeeze marks out of your instructor (maybe give him hints on where to look for the requirements above);
  • Attributions for any code or assets that are not your own.
• Use best practices with file/directory names, commenting and indentation.

Submitting Your Assignment

In order to receive a grade, you must:

1. Deploy your Express app to Heroku.
2. Zip your project (excluding node_modules and .env file) and submit them to Brightspace.
3. Include links to the following as a comment with your Brightspace submission:
   • GH Repo named cpnt262-a5
   • Deployed Heroku App URL