Giters

WDI-SEA / diy-api

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

DIY API — Homework

Deliverable:

It's time to make your own API!

Using what you have learned about Express, Express Routing, RESTful routing, CRUD operations, and Sequelize, use the Sequelize ORM to implement full CRUD functionality on a model (subject of your choosing).

Requirements:

  1. The model you choose to use should have at least three fields, as well an id field.

Example:

column name type
id integer
createdAt timestamp
updatedAt timestamp
name text
wodgets integer
quantity integer
  1. Your API should be accessible via five routes:

Example:

Method Action URL Functionality
GET index /widgets list all widgets
POST create /widgets add a widget
GET detail/show /widgets/:id show one widget
PUT update /widgets/:id update one widget
DELETE delete /widgets/:id delete one widget

Steps to Achieve

You will need to:

  1. Fork and clone this repository!
  2. Run npm init to start your node project.
  3. Create a .gitignore and add everything to ignore
  4. Create your Express App
  5. Sequelize init

Recommended Workflow:

  1. Stub out your routes, write them res.send("test") for initial decleration.
  2. Declare your model and migrate.
  3. Link your model to your server.
  4. Update your routes and make the magic happen!

For the mvp of this deliverable, your DIY API just needs to conform to REST standards and serve JSON from its endpoints. (In express routes, use res.json())

Using thunderclient, you can use the Form-encode tab in the Body of a request to send a payload of form data to your epxress app. This will useful for your PUT and POST routes.

Bonus:

  1. Add a second model to your API. This model should relate to your first model via a 1:M relationship. Once added, update your GET and POST routes for this second model which allow you do the following with your API:
    • Show all elements from second model that relate to your element from first model at :id.
    • Add a new element to your original model that include related elements from this second model at :id.
  2. Add PUT and DELETE functionality to your second model
  3. Add views to your API.
  4. Add a third model to your API, that has a M:M relationship to one one the other two models. Support GET and POST functionality.
  5. Add UPDATE and DELETE to your functionality to your M:M model.

About