fastapi request example data

tinylambda · tinylambda · commit 383f16beb030 · 2022-02-04T00:46:41.000+08:00
diff --git a/module_fastapi/fastapi_parameters_body_nested_model.py b/module_fastapi/fastapi_parameters_body_nested_model.py
@@ -56,3 +56,6 @@ async def create_index_weights(weights: Dict[int, float]):
     print(item1.tags, id(item1.tags))
     print(item2.tags, id(item2.tags))
     assert id(item1.tags) != id(item2.tags)
+
+
+# PYTHONPATH=module_fastapi uvicorn fastapi_parameters_body_nested_model:app --reload
diff --git a/module_fastapi/fastapi_request_example_data.py b/module_fastapi/fastapi_request_example_data.py
@@ -0,0 +1,88 @@
+from typing import Optional
+
+from fastapi import FastAPI, Body
+from pydantic import BaseModel, Field
+
+app = FastAPI()
+
+
+class Item(BaseModel):
+    name: str
+    description: Optional[str] = None
+    price: float
+    tax: Optional[float] = None
+
+    class Config:
+        schema_extra = {
+            'example': {
+                'name': 'Foo',
+                'description': 'A very good Item',
+                'price': 25.4,
+                'tax': 3.4,
+            }
+        }
+
+
+class Item2(BaseModel):
+    name: str = Field(..., example='Foo')
+    description: Optional[str] = Field(None, example='A very good Item')
+    price: float = Field(..., example=33.4)
+    tax: Optional[float] = Field(None, example=3.3)
+
+
+@app.put('/items/{item_id}')
+async def update_item(item_id: int, item: Item):
+    results = {'item_id': item_id, 'item': item}
+    return results
+
+
+@app.put('/items2/{item_id}')
+async def update_item2(item_id: int, item: Item2):
+    results = {'item_id': item_id, 'item': item}
+    return results
+
+
+@app.put('/items3/{item_id}')
+async def update_item3(item_id: int, item: Item = Body(..., example={
+    'name': 'Foo',
+    'description': 'A very good Item !!!',
+    'price': 34.2,
+    'tax': 3.2
+})):
+    results = {'item_id': item_id, 'item': item}
+    return results
+
+
+@app.put('/items4/{item_id}')
+async def update_item3(item_id: int, item: Item = Body(..., examples={
+    "normal": {
+        "summary": "A normal example",
+        "description": "A **normal** item works correctly.",
+        "value": {
+            "name": "Foo",
+            "description": "A very nice Item",
+            "price": 35.4,
+            "tax": 3.2,
+        },
+    },
+    "converted": {
+        "summary": "An example with converted data",
+        "description": "FastAPI can convert price `strings` to actual `numbers` automatically",
+        "value": {
+            "name": "Bar",
+            "price": "35.4",
+        },
+    },
+    "invalid": {
+        "summary": "Invalid data is rejected with an error",
+        "value": {
+            "name": "Baz",
+            "price": "thirty five point four",
+        },
+    },
+})):
+    results = {'item_id': item_id, 'item': item}
+    return results
+
+
+# PYTHONPATH=module_fastapi uvicorn fastapi_request_example_data:app --reload
