Activity 34: Test API in POSTMAN

·

3 min read

Instruction: https://activity.thirdygayares.com/default-guide/system-integration-and-architecture/postman

These descriptions should give you a clear understanding of each API endpoint's purpose and functionality, which is useful for testing and debugging in Postman.

Postman

Try this on Postman:

  1. Add a collection.

  2. Add a request to the collection.

Add 6 Collection

  1. Open Postman.

  2. Click on Collections in the left sidebar.

  3. Click on New Collection.

  4. Name your collection (e.g., "Postman API").

  5. Add a description if necessary.

  • Add Collection 1: User

  • Add Collection 2: Restaurant Category

  • Add Collection 3: Restaurant

  • Add Collection 4: Menu Category

  • Add Collection 5: Menu

  • Hello World (GET)

USER Request

POST: create_user-Creates a new user in the system. Requires user details (like name, email, and password) in the request body.

PUT: update_user-Updates the information of an existing user. The request should include the user ID and updated user details in the body.

DEL: delete_user-Deletes a user from the system using their unique ID. This action typically requires authentication.

GET: Get_user_by_id-Retrieves user details by their unique identifier. Returns user information in the response body.

GET: Get All Users-Fetches a list of all users in the system. Usually returns an array of user objects.

RESTAURANT Category Request

POST: add restaurant category-Adds a new restaurant category. The request must include category details like name and description.

PUT: update_restaurant_category-Updates details of an existing restaurant category using its ID and the new details in the request body.

DEL: delete_restaurant_category-Removes a restaurant category from the system identified by its ID.

GET: Get_restaurant_category_by_id-Retrieves details of a specific restaurant category using its unique identifier.

GET: Get All restaurant_category-Gets a list of all restaurant categories presents in the system.

Restaurant Request

POST: add restaurant-Creates a new restaurant entry. The request should contain information such as name, location, and category.

PUT: update_restaurant-Updates information for an existing restaurant. Requires the restaurant ID and the new data in the request body.

DEL: delete_restaurant-Deletes a specific restaurant from the system using its ID.

GET: Get_restaurant_by_id-Fetches the details of a specific restaurant based on its unique identifier.

GET: Get All restaurant-Returns a list of all restaurants available in the system.

Menu Category Request

POST: add_menu_category-Adds a new menu category for a restaurant. The request should contain category details such as name.

PUT: update_menu_category-Updates an existing menu category identified by its ID in the request body.

DEL: delete_menu_category-Deletes a specific menu category from the system using its unique ID.

GET: Get_menu_category_by_id-Retrieves information about a certain menu category via its ID.

GET: Get All menu_category-Fetches a list of all menu categories in the system.

Menu Request

POST: add_menu-Adds a new menu item to a specific restaurant. The request contains menu details like name, price, and category.

PUT: update_menu-Updates an existing menu item based on its ID and the details provided in the request body.

DEL: delete_menu-Deletes a particular menu item from the system using its unique ID.

GET: Get_menu_by_id-Retrieves the details of a specific menu item identified by its ID.

GET: Get All Menu-Returns a list of all menu items available in the system.

GET: Get_all_menu_by_restaurant-Fetches all menu items associated with a specific restaurant, usually identified by its ID.

GET :Hello_world-A simple test endpoint that typically returns a "Hello, World!" message to confirm that the API is functioning correctly.