Ex: add user retrieval endpoint to show validation error with description

Author: akutayural

examples/fastapi_usage.py

@@ -80,6 +80,10 @@ class ApiKeyModel(BaseModel):
     api_key: str = Field(..., example="b2013852-1798-45fc-9bff-4b6916290f5b", description="Api Key.")
 
 
+class BodyModel(BaseModel):
+    some_int_id: int = Field(..., description="The ID of the user")
+
+
 @app.get(
     "/user/{user_id}",
     response_model=ResponseModel[UserResponse],
@@ -119,6 +123,48 @@ async def get_user(x_user_id: str = Header(default=None),
                          description="User fetched successfully.")
 
 
+
+@app.post(
+    "/user/{user_id}",
+    response_model=ResponseModel[UserResponse],
+    responses=APIResponse.default(),
+    description='''
+Examples:
+- Get user with ID 1: `/user/1` - APIException: If the user ID is 1.
+- Get user with ID 2: `/user/2` - TypeError: If the user ID 2.
+- Get user with ID 3: `/user/3` - KeyError: If the user ID is 3.
+- Get user with ID 4: `/user/4` - IndexError: If the user ID is 4.
+- Get user with ID 5: `/user/5` - ZeroDivisionError: If the user ID is 5.
+- Get user with ID 6: `/user/6` - RuntimeError: If the user ID is 6.
+- Get user with ID 7: `/user/7` - Returns a valid user response.
+'''
+)
+async def get_user(user_id: int = Path(..., description="The ID of the user"),
+                   obj: BodyModel = ...,
+                   ):
+    if user_id == 1:
+        raise APIException(
+            error_code=CustomExceptionCode.USER_NOT_FOUND,
+            http_status_code=404,
+        )
+
+    if user_id == 2:
+        raise TypeError("Invalid type provided.")
+    if user_id == 3:
+        raise KeyError("Missing key in dictionary.")
+    if user_id == 4:
+        raise IndexError("List index out of range.")
+    if user_id == 5:
+        raise ZeroDivisionError("Cannot divide by zero.")
+    if user_id == 6:
+        raise RuntimeError("Unexpected runtime issue.")
+
+    data = UserResponse(id=user_id, username="John Doe")
+    return ResponseModel(data=data,
+                         description="User fetched successfully.")
+
+
+
 @app.get(
     "/apikey",
     response_model=ResponseModel[ApiKeyModel],