Skip to content

Latest commit

 

History

History
28 lines (22 loc) · 1.19 KB

README.md

File metadata and controls

28 lines (22 loc) · 1.19 KB

Kang Ming's API

Set Up

All you gotta do is run docker-compose up

Testing the API

  1. Install Postman
  2. Import the Postman collection titled Apple_Assessment_API.postman_collection.json
  3. Run all the APIs in the collection

Alternatively...

Visit localhost:8000/api/items/ to view the API Root Directory

API Design

API consists of the following endpoints

  1. GET Created 2 different search endpoints for Rack and PDU objects
  2. POST Created 2 different create endpoints for creating Rack and PDU objects
  3. PUT Created 2 different update endpoints for updating Rack and PDU objects based on their ID
  5. GET Created 2 different endpoints for retrieving a specific rack or pdu object based on their ID

Things to work on (if I had more time):

  1. Add Unit tests for every api
  2. Add an authentication token for the API that changes every hour for security purposes
  3. Add User credentials
  4. Find out how to persist data on docker container so there would be available sample data to test with when docker container is run