Imagine going to a shopping mall. There are thousands of products, but you don't need all of them. You want a particular ice cream. So instead of looking through every product, you go directly to the ice-cream section and select the ice cream you want.

Similarly, in a shopping application, the server may have thousands of products. If the client wants a particular product, we need a way to identify and retrieve it. Path parameters and query parameters help the client provide this information through the URL.

In python we define a function with parameters

example
def get_product(product_id):
return product_id

when we call it we provide an argument,here 10 is the argument passed to the function.

A similar idea exists in API URLs. The client can provide values through the URL

Path Parameter

A path parameter is a dynamic value passed directly inside the url path,usally used to identify a specific resource.

example:-

from fastapi import FastAPI

from pydantic import BaseModel

app = FastAPI()

class product(BaseModel):

id: int

name: str

description: str

price: float

quantity: int

products=[

product(id=1,name="phone",description="A smart Phone",price=699.99,quantity=50),

product(id=2,name="Laptop",description="A Powerful Laptop",price=999.9,quantity=30),

product(id=3,name="pen",description="A Blue ink pen",price=19.99,quantity=100),

product(id=4,name="Table",description="A Wooden table",price=220.9,quantity=25)

]

@app.get("/product/{id}")

def get_products(id : int):

for product in products:

if product.id == id:

return product

return f"Product with

the provided {id} is not found"

Here the the parameter "id" can considered as path parameter

Query Parameter:-

A query parameter is a key-value pair added to the URL after ? commonly used to provide additional options such as filtering,searching,pagination and other optional information

from fastapi import FastAPI

from pydantic import BaseModel

app = FastAPI()

class product(BaseModel):

id: int

name: str

description: str

price: float

quantity: int

products=[

product(id=1,name="phone",description="A smart Phone",price=699.99,quantity=50),

product(id=2,name="Laptop",description="A Powerful Laptop",price=999.9,quantity=30),

product(id=3,name="pen",description="A Blue ink pen",price=19.99,quantity=100),

product(id=4,name="Table",description="A Wooden table",price=220.9,quantity=25)

]

@app.get("/product")

def get_products(id : int):

for product in products:

if product.id == id:

return product

return f"Product with the provided {id} is not found"

@app.post("/product")

def add_product(product:product):

products.append(product)

return product

Parameters to URL

Comments

Join Techsnap Creators