API Desing and Testing Objective

Explain how to:

Set up a basic REST API with Flask.

Use Postman to test API endpoints.

Requirements

Python installed on your machine.

Postman installed or accessible via a web browser.

Part $1$: Creating a REST API with Flask

Step $1$: Set up your environment

Install Flask if it's not already installed:

image.png

Create a new Python file named app.py$.$

Step $2$: Write the Flask application

Open app.py and import Flask:

image.png

Define a route for a GET request:

image.png

Define a route for a POST request:

image.png

Add the following code to run the application:

image.png

Step $3$: Run your Flask application

Open your terminal or command prompt.

Run the file by typing:

image.png

The Flask server will start

Part $2$: Testing with Postman

Step $1$: Open Postman

If you haven't already, download and install Postman, or go to PostmanLinks to an external site. for the web version.

Step $2$: Test GET request

Create a new request in Postman.

Set the method to GET.

Enter the URL $($add this to local host url: api$/$items$.)$

Send the request and observe the response.

Step $3$: Test POST request

Create a new request in Postman.

Set the method to POST.

Enter the URL $($add this to local host url: api$/$items$.)$

Under the "Body" tab, choose "raw" and select "JSON" as the format.

Enter the following JSON data:

json

Copy code

$\{"$id$"$: $3,$ "name": "Item $3"\}$

Send the request and observe the response. Please explain each step detailed and any codes necessary