Skip to content

yangellen/cargo_api

Repository files navigation

cargo_api

https://yange-cargo-api.wm.r.appspot.com

Cargo_Api is RESTFul cargo management API built by using Node.js. Datastore is used to store data and the project is deploy with Google App Engine.

  • Users can create new accounts.
  • Users can login, and is shown a JWT and their user id.
  • An endpoint is provided to show the collection of all users.
  • All non-users entities (Boats, Loads) have a root URL that returns the collection of that entity
  • The collection for an unprotedted entity (Loads) must show all the entites in the collection.
  • The collection for a protected entity (Boats) must show only the entites corresponding to the JWT.
  • All root non-users entity collections implement paging of 5 items at a time.
  • All non-users entities (Boats, Loads) have a self link that points to the most canonical representation of that entity instance.
  • All non-users entities (Boats, Loads) support at least 3 properties in addition to any properties modeling relationships, or the id and self property
  • Every non-users (Boats, Loads) entity supports create, read, update (PUT, PATCH), delete operation. The endpoint must be protected for a protected entity (Boats).
  • An protected endpoint for user to assign Load to a Boat.
  • An protected endpoint for user to remove a Load from Boat.
  • 200, 201, 204, 401, 403, 405, 406 status codes are supported.
  • Postman test collection used to test the cargo api.

[email protected]

About

A cargo management RESTful API . Auth0 is used for authentication and authorization.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published