Priya-Raut / java-programming

1 stars 2 forks source link

API endpoints design, development and testing. #4

Open Priya-Raut opened 4 years ago

Priya-Raut commented 4 years ago

Description step 1: Read the links from the reference section below. step 2: Please comment on this issue with the name of the API endpoint you want to design, develop, and test. It will be assigned on a first come first serve basis. Choose as per your level of proficiency. step 3: Write design documentation for that API on anyone these: google doc/README.md/SwaggerHub. step 4: Get it reviewed from one of the mentors @Priya-Raut @Vidhiiii @Tapan123456 @mahakmandlecha step 5: Proceed with development, followed by testing.

References Reference for purpose of each of the following API Reference for design, development, testing of an API

API Design Document Format

  1. API Name
  2. Type: POST/GET etc
  3. Request Body
  4. Success Response Payload
  5. Failure Response Payload

API Endpoints:

  1. InventoryManagementService (easy)

    • [x] get Items (easy)- assigned to @Priya-Raut
    • [ ] add items (easy)- assigned to @madhura11-1
    • [ ] update items (easy) - assigned to @Mohit-Single
    • [ ] delete items (easy) - assigned to @Mohit-Single
    • [ ] reduce items (medium) - assigned to @Mohit-Single
  2. OrderManagementService

    • [ ] place order (medium) - assigned to @Priya-Raut
  3. UserManagementService

    • [ ] register customer/ login customer (advance)
    • [ ] register seller/ login seller (advance)
    • [ ] get Sellers (easy)
  4. Additional

    • [ ] Secure APIs using basic auth/oauth (basic auth) (oauth)
    • [x] Add pagination for GET APIs (reference)
    • [ ] Search for the seller based on name/area
    • [ ] Search for items based on name/category
madhura11-1 commented 4 years ago

Will try to work on Add items API

Priya-Raut commented 4 years ago

@madhura11-1 it is assigned to you now!

ghost commented 4 years ago

work on InventoryManagementService add/update/delete/get api

Priya-Raut commented 4 years ago

@Mohit-Single Good luck!