🚚 Re-sort tutorial example files

docs/tutorial/src/tutorial05-04.py

@@ -1,10 +0,0 @@
-from fastapi import FastAPI
-from fastapi import FastAPI
-
-app = FastAPI()
-
-@app.get("/items/{item_id}")
-async def read_item(item_id: str, q: str = None):
-    if q:
-        return {"item_id": item_id, "q": q}
-    return {"item_id": item_id}

docs/tutorial/src/tutorial06.py

@@ -1,12 +1,10 @@
 from fastapi import FastAPI
+from fastapi import FastAPI
 
 app = FastAPI()
 
 @app.get("/items/{item_id}")
-async def read_item(item_id: str, q: str = None, short: bool = False):
+async def read_item(item_id: str, q: str = None):
-    item = {"item_id": item_id}
     if q:
-        item.update({"q": q})
+        return {"item_id": item_id, "q": q}
-    if not short:
+    return {"item_id": item_id}
-        item.update({"description": "This is an amazing item that has a long description"})
-    return item

docs/tutorial/src/tutorial07.py

@@ -2,9 +2,9 @@ from fastapi import FastAPI
 
 app = FastAPI()
 
-@app.get("/users/{user_id}/items/{item_id}")
+@app.get("/items/{item_id}")
-async def read_user_item(user_id: int, item_id: str, q: str = None, short: bool = False):
+async def read_item(item_id: str, q: str = None, short: bool = False):
-    item = {"item_id": item_id, "owner_id": user_id}
+    item = {"item_id": item_id}
     if q:
         item.update({"q": q})
     if not short:

docs/tutorial/src/tutorial08.py

@@ -3,8 +3,8 @@ from fastapi import FastAPI
 app = FastAPI()
 
 @app.get("/users/{user_id}/items/{item_id}")
-async def read_user_item(user_id: int, item_id: str, needy: str, q: str = None, short: bool = False):
+async def read_user_item(user_id: int, item_id: str, q: str = None, short: bool = False):
-    item = {"item_id": item_id, "owner_id": user_id, "needy": needy}
+    item = {"item_id": item_id, "owner_id": user_id}
     if q:
         item.update({"q": q})
     if not short:

docs/tutorial/src/tutorial09.py

@@ -1,15 +1,12 @@
 from fastapi import FastAPI
-from pydantic import BaseModel
-
-class Item(BaseModel):
-    name: str
-    description: str = None
-    price: float
-    tax: float = None
-
 
 app = FastAPI()
 
-@app.post("/items/")
+@app.get("/users/{user_id}/items/{item_id}")
-async def create_item(item: Item):
+async def read_user_item(user_id: int, item_id: str, needy: str, q: str = None, short: bool = False):
+    item = {"item_id": item_id, "owner_id": user_id, "needy": needy}
+    if q:
+        item.update({"q": q})
+    if not short:
+        item.update({"description": "This is an amazing item that has a long description"})
     return item

docs/tutorial/src/tutorial10.py

@@ -12,8 +12,4 @@ app = FastAPI()
 
 @app.post("/items/")
 async def create_item(item: Item):
-    item_dict = item.dict()
+    return item
-    if item.tax:
-        price_with_tax = item.price + item.tax
-        item_dict.update({"price_with_tax": price_with_tax})
-    return item_dict

docs/tutorial/src/tutorial11.py

@@ -10,6 +10,10 @@ class Item(BaseModel):
 
 app = FastAPI()
 
-@app.put("/items/{item_id}")
+@app.post("/items/")
-async def create_item(item_id: int, item: Item):
+async def create_item(item: Item):
-    return {"item_id": item_id, **item.dict()}
+    item_dict = item.dict()
+    if item.tax:
+        price_with_tax = item.price + item.tax
+        item_dict.update({"price_with_tax": price_with_tax})
+    return item_dict

docs/tutorial/src/tutorial12.py

@@ -11,8 +11,5 @@ class Item(BaseModel):
 app = FastAPI()
 
 @app.put("/items/{item_id}")
-async def create_item(item_id: int, item: Item, q: str = None):
+async def create_item(item_id: int, item: Item):
-    result = {"item_id": item_id, **item.dict()}
+    return {"item_id": item_id, **item.dict()}
-    if q:
-        result.update({"q": q})
-    return result

docs/tutorial/src/tutorial13.py

@@ -1,11 +1,18 @@
-from fastapi import FastAPI, Query
+from fastapi import FastAPI
+from pydantic import BaseModel
+
+class Item(BaseModel):
+    name: str
+    description: str = None
+    price: float
+    tax: float = None
+
 
 app = FastAPI()
 
-
+@app.put("/items/{item_id}")
-@app.get("/items/")
+async def create_item(item_id: int, item: Item, q: str = None):
-async def read_items(q: str = Query(None, max_length=50)):
+    result = {"item_id": item_id, **item.dict()}
-    results = {"items": [{"item_id": "Foo"}, {"item_id": "Bar"}]}
     if q:
-        results.update({"q": q})
+        result.update({"q": q})
-    return results
+    return result

docs/tutorial/src/tutorial14.py

@@ -4,7 +4,7 @@ app = FastAPI()
 
 
 @app.get("/items/")
-async def read_items(q: str = Query(None, min_length=3, max_length=50)):
+async def read_items(q: str = Query(None, max_length=50)):
     results = {"items": [{"item_id": "Foo"}, {"item_id": "Bar"}]}
     if q:
         results.update({"q": q})

docs/tutorial/src/tutorial15.py

@@ -4,7 +4,7 @@ app = FastAPI()
 
 
 @app.get("/items/")
-async def read_items(q: str = Query(None, min_length=3, max_length=50, regex="^fixedquery$")):
+async def read_items(q: str = Query(None, min_length=3, max_length=50)):
     results = {"items": [{"item_id": "Foo"}, {"item_id": "Bar"}]}
     if q:
         results.update({"q": q})

docs/tutorial/src/tutorial16.py

@@ -4,11 +4,7 @@ app = FastAPI()
 
 
 @app.get("/items/")
-async def read_items(
+async def read_items(q: str = Query(None, min_length=3, max_length=50, regex="^fixedquery$")):
-    q: str = Query(
-        None, title="Query string", min_length=3, max_length=50, regex="^fixedquery$"
-    )
-):
     results = {"items": [{"item_id": "Foo"}, {"item_id": "Bar"}]}
     if q:
         results.update({"q": q})

docs/tutorial/src/tutorial17.py

@@ -6,12 +6,7 @@ app = FastAPI()
 @app.get("/items/")
 async def read_items(
     q: str = Query(
-        None,
+        None, title="Query string", min_length=3, max_length=50, regex="^fixedquery$"
-        title="Query string",
-        description="Query string for the items to search in the database that have a good match",
-        min_length=3,
-        max_length=50,
-        regex="^fixedquery$",
     )
 ):
     results = {"items": [{"item_id": "Foo"}, {"item_id": "Bar"}]}

docs/tutorial/src/tutorial18-01.py

@@ -1,21 +0,0 @@
-from fastapi import FastAPI, Query
-
-app = FastAPI()
-
-
-@app.get("/items/")
-async def read_items(
-    q: str = Query(
-        "fixedquery",
-        alias="item-query",
-        title="Query string",
-        description="Query string for the items to search in the database that have a good match",
-        min_length=3,
-        max_length=50,
-        regex="^fixedquery$",
-    )
-):
-    results = {"items": [{"item_id": "Foo"}, {"item_id": "Bar"}]}
-    if q:
-        results.update({"q": q})
-    return results

docs/tutorial/src/tutorial18-03.py

@@ -1,21 +0,0 @@
-from fastapi import FastAPI, Query
-
-app = FastAPI()
-
-
-@app.get("/items/")
-async def read_items(
-    q: str = Query(
-        ...,
-        alias="item-query",
-        title="Query string",
-        description="Query string for the items to search in the database that have a good match",
-        min_length=3,
-        max_length=50,
-        regex="^fixedquery$",
-    )
-):
-    results = {"items": [{"item_id": "Foo"}, {"item_id": "Bar"}]}
-    if q:
-        results.update({"q": q})
-    return results

docs/tutorial/src/tutorial18.py

@@ -7,7 +7,6 @@ app = FastAPI()
 async def read_items(
     q: str = Query(
         None,
-        alias="item-query",
         title="Query string",
         description="Query string for the items to search in the database that have a good match",
         min_length=3,

docs/tutorial/src/tutorial19.py

@@ -6,14 +6,13 @@ app = FastAPI()
 @app.get("/items/")
 async def read_items(
     q: str = Query(
-        None,
+        "fixedquery",
         alias="item-query",
         title="Query string",
         description="Query string for the items to search in the database that have a good match",
         min_length=3,
         max_length=50,
         regex="^fixedquery$",
-        deprecated=True,
     )
 ):
     results = {"items": [{"item_id": "Foo"}, {"item_id": "Bar"}]}

docs/tutorial/src/tutorial20.py

@@ -1,14 +1,21 @@
-from fastapi import FastAPI, Query, Path
+from fastapi import FastAPI, Query
 
 app = FastAPI()
 
 
-@app.get("/items/{item_id}")
+@app.get("/items/")
 async def read_items(
-    item_id: int = Path(..., title="The ID of the item to get"),
+    q: str = Query(
-    q: str = Query(None, alias="item-query"),
+        None,
+        alias="item-query",
+        title="Query string",
+        description="Query string for the items to search in the database that have a good match",
+        min_length=3,
+        max_length=50,
+        regex="^fixedquery$",
+    )
 ):
-    results = {"item_id": item_id}
+    results = {"items": [{"item_id": "Foo"}, {"item_id": "Bar"}]}
     if q:
         results.update({"q": q})
     return results

docs/tutorial/src/tutorial21.py

@@ -1,14 +1,21 @@
-from fastapi import FastAPI, Query, Path
+from fastapi import FastAPI, Query
 
 app = FastAPI()
 
 
-@app.get("/items/{item_id}")
+@app.get("/items/")
 async def read_items(
-    q: str,
+    q: str = Query(
-    item_id: int = Path(..., title="The ID of the item to get"),
+        ...,
+        alias="item-query",
+        title="Query string",
+        description="Query string for the items to search in the database that have a good match",
+        min_length=3,
+        max_length=50,
+        regex="^fixedquery$",
+    )
 ):
-    results = {"item_id": item_id}
+    results = {"items": [{"item_id": "Foo"}, {"item_id": "Bar"}]}
     if q:
         results.update({"q": q})
     return results

docs/tutorial/src/tutorial22.py

@@ -1,15 +1,22 @@
-from fastapi import FastAPI, Query, Path
+from fastapi import FastAPI, Query
 
 app = FastAPI()
 
 
-@app.get("/items/{item_id}")
+@app.get("/items/")
 async def read_items(
-    *,
+    q: str = Query(
-    item_id: int = Path(..., title="The ID of the item to get"),
+        None,
-    q: str,
+        alias="item-query",
+        title="Query string",
+        description="Query string for the items to search in the database that have a good match",
+        min_length=3,
+        max_length=50,
+        regex="^fixedquery$",
+        deprecated=True,
+    )
 ):
-    results = {"item_id": item_id}
+    results = {"items": [{"item_id": "Foo"}, {"item_id": "Bar"}]}
     if q:
         results.update({"q": q})
     return results

docs/tutorial/src/tutorial23.py

@@ -5,9 +5,8 @@ app = FastAPI()
 
 @app.get("/items/{item_id}")
 async def read_items(
-    *,
+    item_id: int = Path(..., title="The ID of the item to get"),
-    item_id: int = Path(..., title="The ID of the item to get", ge=1),
+    q: str = Query(None, alias="item-query"),
-    q: str,
 ):
     results = {"item_id": item_id}
     if q:

docs/tutorial/src/tutorial24.py

@@ -5,9 +5,8 @@ app = FastAPI()
 
 @app.get("/items/{item_id}")
 async def read_items(
-    *,
-    item_id: int = Path(..., title="The ID of the item to get", gt=0, le=1000),
     q: str,
+    item_id: int = Path(..., title="The ID of the item to get"),
 ):
     results = {"item_id": item_id}
     if q:

docs/tutorial/src/tutorial25.py

@@ -6,9 +6,8 @@ app = FastAPI()
 @app.get("/items/{item_id}")
 async def read_items(
     *,
-    item_id: int = Path(..., title="The ID of the item to get", ge=0, le=1000),
+    item_id: int = Path(..., title="The ID of the item to get"),
     q: str,
-    size: float = Query(..., gt=0, lt=10.5)
 ):
     results = {"item_id": item_id}
     if q:

docs/tutorial/src/tutorial26.py

@@ -1,26 +1,15 @@
 from fastapi import FastAPI, Query, Path
-from pydantic import BaseModel
 
 app = FastAPI()
 
 
-class Item(BaseModel):
+@app.get("/items/{item_id}")
-    name: str
+async def read_items(
-    description: str = None
-    price: float
-    tax: float = None
-
-
-@app.put("/items/{item_id}")
-async def update_item(
     *,
-    item_id: int = Path(..., title="The ID of the item to get", ge=0, le=1000),
+    item_id: int = Path(..., title="The ID of the item to get", ge=1),
     q: str,
-    item: Item = None,
 ):
     results = {"item_id": item_id}
     if q:
         results.update({"q": q})
-    if item:
-        results.update({"item": item})
     return results

docs/tutorial/src/tutorial27.py

@@ -1,27 +1,15 @@
 from fastapi import FastAPI, Query, Path
-from pydantic import BaseModel
 
 app = FastAPI()
 
 
-class Item(BaseModel):
+@app.get("/items/{item_id}")
-    name: str
+async def read_items(
-    description: str = None
-    price: float
-    tax: float = None
-
-
-class User(BaseModel):
-    username: str
-    full_name: str = None
-
-
-@app.put("/items/{item_id}")
-async def update_item(
     *,
-    item_id: int,
+    item_id: int = Path(..., title="The ID of the item to get", gt=0, le=1000),
-    item: Item,
+    q: str,
-    user: User,
 ):
-    results = {"item_id": item_id, "item": item, "user": user}
+    results = {"item_id": item_id}
+    if q:
+        results.update({"q": q})
     return results

docs/tutorial/src/tutorial28.py

@@ -1,28 +1,16 @@
-from fastapi import FastAPI, Query, Path, Body
+from fastapi import FastAPI, Query, Path
-from pydantic import BaseModel
 
 app = FastAPI()
 
 
-class Item(BaseModel):
+@app.get("/items/{item_id}")
-    name: str
+async def read_items(
-    description: str = None
-    price: float
-    tax: float = None
-
-
-class User(BaseModel):
-    username: str
-    full_name: str = None
-
-
-@app.put("/items/{item_id}")
-async def update_item(
     *,
-    item_id: int,
+    item_id: int = Path(..., title="The ID of the item to get", ge=0, le=1000),
-    item: Item,
+    q: str,
-    user: User,
+    size: float = Query(..., gt=0, lt=10.5)
-    access_token: str = Body(...),
 ):
-    results = {"item_id": item_id, "item": item, "user": user, "access_token": access_token}
+    results = {"item_id": item_id}
+    if q:
+        results.update({"q": q})
     return results

docs/tutorial/src/tutorial29.py

@@ -1,4 +1,4 @@
-from fastapi import FastAPI, Query, Path, Body
+from fastapi import FastAPI, Query, Path
 from pydantic import BaseModel
 
 app = FastAPI()
@@ -11,21 +11,16 @@ class Item(BaseModel):
     tax: float = None
 
 
-class User(BaseModel):
-    username: str
-    full_name: str = None
-
-
 @app.put("/items/{item_id}")
 async def update_item(
     *,
-    item_id: int,
+    item_id: int = Path(..., title="The ID of the item to get", ge=0, le=1000),
-    item: Item,
+    q: str,
-    user: User,
+    item: Item = None,
-    access_token: str = Body(...),
-    q: str = None,
 ):
-    results = {"item_id": item_id, "item": item, "user": user, "access_token": access_token}
+    results = {"item_id": item_id}
     if q:
         results.update({"q": q})
+    if item:
+        results.update({"item": item})
     return results

docs/tutorial/src/tutorial30.py

@@ -1,4 +1,4 @@
-from fastapi import FastAPI, Query, Path, Body
+from fastapi import FastAPI, Query, Path
 from pydantic import BaseModel
 
 app = FastAPI()
@@ -11,11 +11,17 @@ class Item(BaseModel):
     tax: float = None
 
 
+class User(BaseModel):
+    username: str
+    full_name: str = None
+
+
 @app.put("/items/{item_id}")
 async def update_item(
     *,
     item_id: int,
-    item: Item = Body(..., embed=True),
+    item: Item,
+    user: User,
 ):
-    results = {"item_id": item_id, "item": item}
+    results = {"item_id": item_id, "item": item, "user": user}
     return results

docs/tutorial/src/tutorial31.py

@@ -1,21 +1,28 @@
 from fastapi import FastAPI, Query, Path, Body
-from pydantic import BaseModel, Schema
+from pydantic import BaseModel
 
 app = FastAPI()
 
 
 class Item(BaseModel):
     name: str
-    description: str = Schema(None, title="The description of the item", max_length=300)
+    description: str = None
-    price: float = Schema(..., gt=0, description="The price must be greater than zero")
+    price: float
     tax: float = None
 
 
+class User(BaseModel):
+    username: str
+    full_name: str = None
+
+
 @app.put("/items/{item_id}")
 async def update_item(
     *,
     item_id: int,
-    item: Item = Body(..., embed=True),
+    item: Item,
+    user: User,
+    access_token: str = Body(...),
 ):
-    results = {"item_id": item_id, "item": item}
+    results = {"item_id": item_id, "item": item, "user": user, "access_token": access_token}
     return results

docs/tutorial/src/tutorial32.py

@@ -9,7 +9,11 @@ class Item(BaseModel):
     description: str = None
     price: float
     tax: float = None
-    tags: list = []
+
+
+class User(BaseModel):
+    username: str
+    full_name: str = None
 
 
 @app.put("/items/{item_id}")
@@ -17,6 +21,11 @@ async def update_item(
     *,
     item_id: int,
     item: Item,
+    user: User,
+    access_token: str = Body(...),
+    q: str = None,
 ):
-    results = {"item_id": item_id, "item": item}
+    results = {"item_id": item_id, "item": item, "user": user, "access_token": access_token}
+    if q:
+        results.update({"q": q})
     return results

docs/tutorial/src/tutorial33.py

@@ -1,6 +1,5 @@
-from fastapi import Body, FastAPI, Path, Query
+from fastapi import FastAPI, Query, Path, Body
 from pydantic import BaseModel
-from typing import List
 
 app = FastAPI()
 
@@ -10,14 +9,13 @@ class Item(BaseModel):
     description: str = None
     price: float
     tax: float = None
-    tags: List[str] = []
 
 
 @app.put("/items/{item_id}")
 async def update_item(
     *,
     item_id: int,
-    item: Item,
+    item: Item = Body(..., embed=True),
 ):
     results = {"item_id": item_id, "item": item}
     return results

docs/tutorial/src/tutorial34.py

@@ -1,23 +1,21 @@
-from fastapi import Body, FastAPI, Path, Query
+from fastapi import FastAPI, Query, Path, Body
-from pydantic import BaseModel
+from pydantic import BaseModel, Schema
-from typing import Set
 
 app = FastAPI()
 
 
 class Item(BaseModel):
     name: str
-    description: str = None
+    description: str = Schema(None, title="The description of the item", max_length=300)
-    price: float
+    price: float = Schema(..., gt=0, description="The price must be greater than zero")
     tax: float = None
-    tags: Set[str] = []
 
 
 @app.put("/items/{item_id}")
 async def update_item(
     *,
     item_id: int,
-    item: Item,
+    item: Item = Body(..., embed=True),
 ):
     results = {"item_id": item_id, "item": item}
     return results

docs/tutorial/src/tutorial35.py

@@ -1,22 +1,15 @@
-from fastapi import Body, FastAPI, Path, Query
+from fastapi import FastAPI, Query, Path, Body
 from pydantic import BaseModel
-from typing import Set
 
 app = FastAPI()
 
 
-class Image(BaseModel):
-    url: str
-    name: str
-
-
 class Item(BaseModel):
     name: str
     description: str = None
     price: float
     tax: float = None
-    tags: Set[str] = []
+    tags: list = []
-    image: Image = None
 
 
 @app.put("/items/{item_id}")

docs/tutorial/src/tutorial36.py

@@ -1,23 +1,16 @@
 from fastapi import Body, FastAPI, Path, Query
 from pydantic import BaseModel
-from pydantic.types import UrlStr
+from typing import List
-from typing import Set
 
 app = FastAPI()
 
 
-class Image(BaseModel):
-    url: UrlStr
-    name: str
-
-
 class Item(BaseModel):
     name: str
     description: str = None
     price: float
     tax: float = None
-    tags: Set[str] = []
+    tags: List[str] = []
-    image: Image = None
 
 
 @app.put("/items/{item_id}")

docs/tutorial/src/tutorial37.py

@@ -1,23 +1,16 @@
 from fastapi import Body, FastAPI, Path, Query
 from pydantic import BaseModel
-from pydantic.types import UrlStr
+from typing import Set
-from typing import Set, List
 
 app = FastAPI()
 
 
-class Image(BaseModel):
-    url: UrlStr
-    name: str
-
-
 class Item(BaseModel):
     name: str
     description: str = None
     price: float
     tax: float = None
     tags: Set[str] = []
-    image: List[Image] = None
 
 
 @app.put("/items/{item_id}")

docs/tutorial/src/tutorial38.py

@@ -1,13 +1,12 @@
 from fastapi import Body, FastAPI, Path, Query
 from pydantic import BaseModel
-from pydantic.types import UrlStr
+from typing import Set
-from typing import Set, List
 
 app = FastAPI()
 
 
 class Image(BaseModel):
-    url: UrlStr
+    url: str
     name: str
 
 
@@ -17,16 +16,14 @@ class Item(BaseModel):
     price: float
     tax: float = None
     tags: Set[str] = []
-    image: List[Image] = None
+    image: Image = None
 
 
-class Offer(BaseModel):
+@app.put("/items/{item_id}")
-    name: str
+async def update_item(
-    description: str = None
+    *,
-    price: float
+    item_id: int,
-    items: List[Item]
+    item: Item,
-
+):
-
+    results = {"item_id": item_id, "item": item}
-@app.post("/offers/")
+    return results
-async def create_offer(*, offer: Offer):
-    return offer

docs/tutorial/src/tutorial39.py

@@ -1,7 +1,7 @@
 from fastapi import Body, FastAPI, Path, Query
 from pydantic import BaseModel
 from pydantic.types import UrlStr
-from typing import Set, List
+from typing import Set
 
 app = FastAPI()
 
@@ -11,6 +11,20 @@ class Image(BaseModel):
     name: str
 
 
-@app.post("/images/multiple/")
+class Item(BaseModel):
-async def create_multiple_images(*, images: List[Image]):
+    name: str
-    return images
+    description: str = None
+    price: float
+    tax: float = None
+    tags: Set[str] = []
+    image: Image = None
+
+
+@app.put("/items/{item_id}")
+async def update_item(
+    *,
+    item_id: int,
+    item: Item,
+):
+    results = {"item_id": item_id, "item": item}
+    return results

docs/tutorial/src/tutorial40.py

@@ -1,4 +1,4 @@
-from fastapi import FastAPI, Cookie
+from fastapi import Body, FastAPI, Path, Query
 from pydantic import BaseModel
 from pydantic.types import UrlStr
 from typing import Set, List
@@ -6,6 +6,25 @@ from typing import Set, List
 app = FastAPI()
 
 
-@app.get("/items/")
+class Image(BaseModel):
-async def read_items(*, ads_id: str = Cookie(None)):
+    url: UrlStr
-    return {"ads_id": ads_id}
+    name: str
+
+
+class Item(BaseModel):
+    name: str
+    description: str = None
+    price: float
+    tax: float = None
+    tags: Set[str] = []
+    image: List[Image] = None
+
+
+@app.put("/items/{item_id}")
+async def update_item(
+    *,
+    item_id: int,
+    item: Item,
+):
+    results = {"item_id": item_id, "item": item}
+    return results

docs/tutorial/src/tutorial41.py

@@ -1,4 +1,4 @@
-from fastapi import FastAPI, Header
+from fastapi import Body, FastAPI, Path, Query
 from pydantic import BaseModel
 from pydantic.types import UrlStr
 from typing import Set, List
@@ -6,6 +6,27 @@ from typing import Set, List
 app = FastAPI()
 
 
-@app.get("/items/")
+class Image(BaseModel):
-async def read_items(*, accept_encoding: str = Header(None)):
+    url: UrlStr
-    return {"Accept-Encoding": accept_encoding}
+    name: str
+
+
+class Item(BaseModel):
+    name: str
+    description: str = None
+    price: float
+    tax: float = None
+    tags: Set[str] = []
+    image: List[Image] = None
+
+
+class Offer(BaseModel):
+    name: str
+    description: str = None
+    price: float
+    items: List[Item]
+
+
+@app.post("/offers/")
+async def create_offer(*, offer: Offer):
+    return offer

docs/tutorial/src/tutorial42.py

@@ -1,4 +1,4 @@
-from fastapi import FastAPI, Header
+from fastapi import Body, FastAPI, Path, Query
 from pydantic import BaseModel
 from pydantic.types import UrlStr
 from typing import Set, List
@@ -6,6 +6,11 @@ from typing import Set, List
 app = FastAPI()
 
 
-@app.get("/items/")
+class Image(BaseModel):
-async def read_items(*, strange_header: str = Header(None, convert_underscores=False)):
+    url: UrlStr
-    return {"strange_header": strange_header}
+    name: str
+
+
+@app.post("/images/multiple/")
+async def create_multiple_images(*, images: List[Image]):
+    return images

docs/tutorial/src/tutorial43.py

@@ -1,4 +1,4 @@
-from fastapi import Body, FastAPI, Path, Query
+from fastapi import FastAPI, Cookie
 from pydantic import BaseModel
 from pydantic.types import UrlStr
 from typing import Set, List
@@ -6,14 +6,6 @@ from typing import Set, List
 app = FastAPI()
 
 
-class Item(BaseModel):
+@app.get("/items/")
-    name: str
+async def read_items(*, ads_id: str = Cookie(None)):
-    description: str = None
+    return {"ads_id": ads_id}
-    price: float
-    tax: float = None
-    tags: Set[str] = []
-
-
-@app.post("/items/", response_model=Item)
-async def create_item(*, item: Item):
-    return item

docs/tutorial/src/tutorial44.py

@@ -1,20 +1,11 @@
-from fastapi import Body, FastAPI, Path, Query
+from fastapi import FastAPI, Header
 from pydantic import BaseModel
-from pydantic.types import EmailStr
+from pydantic.types import UrlStr
 from typing import Set, List
 
 app = FastAPI()
 
 
-class UserIn(BaseModel):
+@app.get("/items/")
-    username: str
+async def read_items(*, accept_encoding: str = Header(None)):
-    password: str
+    return {"Accept-Encoding": accept_encoding}
-    email: EmailStr
-    full_name: str = None
-    
-
-
-# Don't do this in production!
-@app.post("/user/", response_model=UserIn)
-async def create_user(*, user: UserIn):
-    return user

docs/tutorial/src/tutorial45.py

@@ -1,24 +1,11 @@
-from fastapi import Body, FastAPI, Path, Query
+from fastapi import FastAPI, Header
 from pydantic import BaseModel
-from pydantic.types import EmailStr
+from pydantic.types import UrlStr
 from typing import Set, List
 
 app = FastAPI()
 
 
-class UserIn(BaseModel):
+@app.get("/items/")
-    username: str
+async def read_items(*, strange_header: str = Header(None, convert_underscores=False)):
-    password: str
+    return {"strange_header": strange_header}
-    email: EmailStr
-    full_name: str = None
-
-
-class UserOut(BaseModel):
-    username: str
-    email: EmailStr
-    full_name: str = None
-
-
-@app.post("/user/", response_model=UserOut)
-async def create_user(*, user: UserIn):
-    return user

docs/tutorial/src/tutorial46.py

@@ -1,43 +1,19 @@
 from fastapi import Body, FastAPI, Path, Query
 from pydantic import BaseModel
-from pydantic.types import EmailStr
+from pydantic.types import UrlStr
 from typing import Set, List
-from uuid import UUID, uuid4
 
 app = FastAPI()
 
 
-class UserIn(BaseModel):
+class Item(BaseModel):
-    username: str
+    name: str
-    password: str
+    description: str = None
-    email: EmailStr
+    price: float
-    full_name: str = None
+    tax: float = None
+    tags: Set[str] = []
 
 
-class UserOut(BaseModel):
+@app.post("/items/", response_model=Item)
-    username: str
+async def create_item(*, item: Item):
-    email: EmailStr
+    return item
-    full_name: str = None
-
-
-class UserInDB(BaseModel):
-    username: str
-    hashed_password: str
-    email: EmailStr
-    full_name: str = None
-
-
-def fake_password_hasher(raw_password: str):
-    return "supersecret" + raw_password
-
-
-def fake_save_user(user_in: UserIn):
-    hashed_password = fake_password_hasher(user_in.password)
-    user_in_db = UserInDB(**user_in.dict(), hashed_password=hashed_password)
-    print("User saved! ..not really")
-    return user_in_db
-
-@app.post("/user/", response_model=UserOut)
-async def create_user(*, user_in: UserIn):
-    user_saved = fake_save_user(user_in)
-    return user_saved

docs/tutorial/src/tutorial47-01.py

@@ -1,37 +0,0 @@
-from fastapi import Body, FastAPI, Path, Query
-from pydantic import BaseModel
-from pydantic.types import EmailStr
-from typing import Set, List
-
-app = FastAPI()
-
-class UserBase(BaseModel):
-    username: str
-    email: EmailStr
-    full_name: str = None
-
-class UserIn(UserBase):
-    password: str
-
-
-class UserOut(UserBase):
-    pass
-
-class UserInDB(UserBase):
-    hashed_password: str
-    
-
-def fake_password_hasher(raw_password: str):
-    return "supersecret" + raw_password
-
-
-def fake_save_user(user_in: UserIn):
-    hashed_password = fake_password_hasher(user_in.password)
-    user_in_db = UserInDB(**user_in.dict(), hashed_password=hashed_password)
-    print("User saved! ..not really")
-    return user_in_db
-
-@app.post("/user/", response_model=UserOut)
-async def create_user(*, user_in: UserIn):
-    user_saved = fake_save_user(user_in)
-    return user_saved

docs/tutorial/src/tutorial47-02.py

@@ -1,11 +0,0 @@
-from fastapi import Body, FastAPI, Path, Query, Form
-from pydantic import BaseModel
-from pydantic.types import EmailStr
-from typing import Set, List
-
-app = FastAPI()
-
-
-@app.post("/login/")
-async def login(*, username: str = Form(...), password: str = Form(...)):
-    return {"username": username}

docs/tutorial/src/tutorial47-03.py

@@ -1,11 +0,0 @@
-from fastapi import Body, FastAPI, Path, Query, File
-from pydantic import BaseModel
-from pydantic.types import EmailStr
-from typing import Set, List
-
-app = FastAPI()
-
-
-@app.post("/files/")
-async def create_file(*, file: bytes = File(...)):
-    return {"file_size": len(file)}

docs/tutorial/src/tutorial47-04.py

@@ -1,11 +0,0 @@
-from fastapi import Body, FastAPI, Path, Query, File, Form
-from pydantic import BaseModel
-from pydantic.types import EmailStr
-from typing import Set, List
-
-app = FastAPI()
-
-
-@app.post("/files/")
-async def create_file(*, file: bytes = File(...), token: str = Form(...)):
-    return {"file_size": len(file), "token": token}

docs/tutorial/src/tutorial47.py

@@ -0,0 +1,20 @@
+from fastapi import Body, FastAPI, Path, Query
+from pydantic import BaseModel
+from pydantic.types import EmailStr
+from typing import Set, List
+
+app = FastAPI()
+
+
+class UserIn(BaseModel):
+    username: str
+    password: str
+    email: EmailStr
+    full_name: str = None
+    
+
+
+# Don't do this in production!
+@app.post("/user/", response_model=UserIn)
+async def create_user(*, user: UserIn):
+    return user

docs/tutorial/src/tutorial48.py

@@ -1,20 +1,24 @@
 from fastapi import Body, FastAPI, Path, Query
-from starlette.status import HTTP_201_CREATED
 from pydantic import BaseModel
-from pydantic.types import UrlStr
+from pydantic.types import EmailStr
 from typing import Set, List
 
 app = FastAPI()
 
 
-class Item(BaseModel):
+class UserIn(BaseModel):
-    name: str
+    username: str
-    description: str = None
+    password: str
-    price: float
+    email: EmailStr
-    tax: float = None
+    full_name: str = None
-    tags: Set[str] = []
 
 
-@app.post("/items/", response_model=Item, status_code=HTTP_201_CREATED)
+class UserOut(BaseModel):
-async def create_item(*, item: Item):
+    username: str
-    return item
+    email: EmailStr
+    full_name: str = None
+
+
+@app.post("/user/", response_model=UserOut)
+async def create_user(*, user: UserIn):
+    return user

docs/tutorial/src/tutorial49.py

@@ -1,20 +1,43 @@
 from fastapi import Body, FastAPI, Path, Query
-from starlette.status import HTTP_201_CREATED
 from pydantic import BaseModel
-from pydantic.types import UrlStr
+from pydantic.types import EmailStr
 from typing import Set, List
+from uuid import UUID, uuid4
 
 app = FastAPI()
 
 
-class Item(BaseModel):
+class UserIn(BaseModel):
-    name: str
+    username: str
-    description: str = None
+    password: str
-    price: float
+    email: EmailStr
-    tax: float = None
+    full_name: str = None
-    tags: Set[str] = []
 
 
-@app.post("/items/", response_model=Item, tags=["items"])
+class UserOut(BaseModel):
-async def create_item(*, item: Item):
+    username: str
-    return item
+    email: EmailStr
+    full_name: str = None
+
+
+class UserInDB(BaseModel):
+    username: str
+    hashed_password: str
+    email: EmailStr
+    full_name: str = None
+
+
+def fake_password_hasher(raw_password: str):
+    return "supersecret" + raw_password
+
+
+def fake_save_user(user_in: UserIn):
+    hashed_password = fake_password_hasher(user_in.password)
+    user_in_db = UserInDB(**user_in.dict(), hashed_password=hashed_password)
+    print("User saved! ..not really")
+    return user_in_db
+
+@app.post("/user/", response_model=UserOut)
+async def create_user(*, user_in: UserIn):
+    user_saved = fake_save_user(user_in)
+    return user_saved

docs/tutorial/src/tutorial50.py

@@ -1,25 +1,37 @@
 from fastapi import Body, FastAPI, Path, Query
-from starlette.status import HTTP_201_CREATED
 from pydantic import BaseModel
-from pydantic.types import UrlStr
+from pydantic.types import EmailStr
 from typing import Set, List
 
 app = FastAPI()
 
+class UserBase(BaseModel):
+    username: str
+    email: EmailStr
+    full_name: str = None
 
-class Item(BaseModel):
+class UserIn(UserBase):
-    name: str
+    password: str
-    description: str = None
-    price: float
-    tax: float = None
-    tags: Set[str] = []
 
 
-@app.post(
+class UserOut(UserBase):
-    "/items/",
+    pass
-    response_model=Item,
+
-    summary="Create an item",
+class UserInDB(UserBase):
-    description="Create an item with all the information, name, description, price, tax and a set of unique tags",
+    hashed_password: str
-)
+    
-async def create_item(*, item: Item):
+
-    return item
+def fake_password_hasher(raw_password: str):
+    return "supersecret" + raw_password
+
+
+def fake_save_user(user_in: UserIn):
+    hashed_password = fake_password_hasher(user_in.password)
+    user_in_db = UserInDB(**user_in.dict(), hashed_password=hashed_password)
+    print("User saved! ..not really")
+    return user_in_db
+
+@app.post("/user/", response_model=UserOut)
+async def create_user(*, user_in: UserIn):
+    user_saved = fake_save_user(user_in)
+    return user_saved

docs/tutorial/src/tutorial51.py

@@ -1,29 +1,11 @@
-from fastapi import Body, FastAPI, Path, Query
+from fastapi import Body, FastAPI, Path, Query, Form
-from starlette.status import HTTP_201_CREATED
 from pydantic import BaseModel
-from pydantic.types import UrlStr
+from pydantic.types import EmailStr
 from typing import Set, List
 
 app = FastAPI()
 
 
-class Item(BaseModel):
+@app.post("/login/")
-    name: str
+async def login(*, username: str = Form(...), password: str = Form(...)):
-    description: str = None
+    return {"username": username}
-    price: float
-    tax: float = None
-    tags: Set[str] = []
-
-
-@app.post("/items/", response_model=Item, summary="Create an item")
-async def create_item(*, item: Item):
-    """
-    Create an item with all the information:
-    
-    * name: each item must have a name
-    * description: a long description
-    * price: required
-    * tax: if the item doesn't have tax, you can omit this
-    * tags: a set of unique tag strings for this item
-    """
-    return item

docs/tutorial/src/tutorial52.py

@@ -1,29 +1,11 @@
-from fastapi import Body, FastAPI, Path, Query
+from fastapi import Body, FastAPI, Path, Query, File
-from starlette.status import HTTP_201_CREATED
 from pydantic import BaseModel
-from pydantic.types import UrlStr
+from pydantic.types import EmailStr
 from typing import Set, List
 
 app = FastAPI()
 
 
-class Item(BaseModel):
+@app.post("/files/")
-    name: str
+async def create_file(*, file: bytes = File(...)):
-    description: str = None
+    return {"file_size": len(file)}
-    price: float
-    tax: float = None
-    tags: Set[str] = []
-
-
-@app.post("/items/", response_model=Item, summary="Create an item", response_description="The created item")
-async def create_item(*, item: Item):
-    """
-    Create an item with all the information:
-    
-    * name: each item must have a name
-    * description: a long description
-    * price: required
-    * tax: if the item doesn't have tax, you can omit this
-    * tags: a set of unique tag strings for this item
-    """
-    return item

docs/tutorial/src/tutorial53.py

@@ -1,13 +1,11 @@
-from typing import List, Set
+from fastapi import Body, FastAPI, Path, Query, File, Form
-
-from fastapi import Body, FastAPI, Path, Query
 from pydantic import BaseModel
-from pydantic.types import UrlStr
+from pydantic.types import EmailStr
-from starlette.status import HTTP_201_CREATED
+from typing import Set, List
 
 app = FastAPI()
 
 
-@app.get("/items/", deprecated=True)
+@app.post("/files/")
-async def read_items():
+async def create_file(*, file: bytes = File(...), token: str = Form(...)):
-    return [{"item_id": "Foo"}]
+    return {"file_size": len(file), "token": token}

docs/tutorial/src/tutorial54.py

@@ -1,13 +1,20 @@
-from typing import List, Set
-
 from fastapi import Body, FastAPI, Path, Query
+from starlette.status import HTTP_201_CREATED
 from pydantic import BaseModel
 from pydantic.types import UrlStr
-from starlette.status import HTTP_201_CREATED
+from typing import Set, List
 
 app = FastAPI()
 
 
-@app.get("/items/", operation_id="some_specific_id_you_define")
+class Item(BaseModel):
-async def read_items():
+    name: str
-    return [{"item_id": "Foo"}]
+    description: str = None
+    price: float
+    tax: float = None
+    tags: Set[str] = []
+
+
+@app.post("/items/", response_model=Item, status_code=HTTP_201_CREATED)
+async def create_item(*, item: Item):
+    return item

docs/tutorial/src/tutorial55.py

@@ -1,13 +1,20 @@
-from typing import List, Set
-
 from fastapi import Body, FastAPI, Path, Query
+from starlette.status import HTTP_201_CREATED
 from pydantic import BaseModel
 from pydantic.types import UrlStr
-from starlette.status import HTTP_201_CREATED
+from typing import Set, List
 
 app = FastAPI()
 
 
-@app.get("/items/", include_in_schema=False)
+class Item(BaseModel):
-async def read_items():
+    name: str
-    return [{"item_id": "Foo"}]
+    description: str = None
+    price: float
+    tax: float = None
+    tags: Set[str] = []
+
+
+@app.post("/items/", response_model=Item, tags=["items"])
+async def create_item(*, item: Item):
+    return item

docs/tutorial/src/tutorial56.py

@@ -1,14 +1,25 @@
-from typing import List, Set
-
 from fastapi import Body, FastAPI, Path, Query
+from starlette.status import HTTP_201_CREATED
 from pydantic import BaseModel
 from pydantic.types import UrlStr
-from starlette.status import HTTP_201_CREATED
+from typing import Set, List
-from starlette.responses import UJSONResponse
 
 app = FastAPI()
 
 
-@app.get("/items/", content_type=UJSONResponse)
+class Item(BaseModel):
-async def read_items():
+    name: str
-    return [{"item_id": "Foo"}]
+    description: str = None
+    price: float
+    tax: float = None
+    tags: Set[str] = []
+
+
+@app.post(
+    "/items/",
+    response_model=Item,
+    summary="Create an item",
+    description="Create an item with all the information, name, description, price, tax and a set of unique tags",
+)
+async def create_item(*, item: Item):
+    return item

docs/tutorial/src/tutorial57.py

@@ -1,23 +1,29 @@
-from typing import List, Set
-
 from fastapi import Body, FastAPI, Path, Query
+from starlette.status import HTTP_201_CREATED
 from pydantic import BaseModel
 from pydantic.types import UrlStr
-from starlette.status import HTTP_201_CREATED
+from typing import Set, List
-from starlette.responses import HTMLResponse
 
 app = FastAPI()
 
 
-@app.get("/items/", content_type=HTMLResponse)
+class Item(BaseModel):
-async def read_items():
+    name: str
-    return """
+    description: str = None
-    <html>
+    price: float
-        <head>
+    tax: float = None
-            <title>Some HTML in here</title>
+    tags: Set[str] = []
-        </head>
+
-        <body>
+
-            <h1>Look ma! HTML!</h1>
+@app.post("/items/", response_model=Item, summary="Create an item")
-        </body>
+async def create_item(*, item: Item):
-    </html>
     """
+    Create an item with all the information:
+    
+    * name: each item must have a name
+    * description: a long description
+    * price: required
+    * tax: if the item doesn't have tax, you can omit this
+    * tags: a set of unique tag strings for this item
+    """
+    return item

docs/tutorial/src/tutorial58.py

@@ -0,0 +1,29 @@
+from fastapi import Body, FastAPI, Path, Query
+from starlette.status import HTTP_201_CREATED
+from pydantic import BaseModel
+from pydantic.types import UrlStr
+from typing import Set, List
+
+app = FastAPI()
+
+
+class Item(BaseModel):
+    name: str
+    description: str = None
+    price: float
+    tax: float = None
+    tags: Set[str] = []
+
+
+@app.post("/items/", response_model=Item, summary="Create an item", response_description="The created item")
+async def create_item(*, item: Item):
+    """
+    Create an item with all the information:
+    
+    * name: each item must have a name
+    * description: a long description
+    * price: required
+    * tax: if the item doesn't have tax, you can omit this
+    * tags: a set of unique tag strings for this item
+    """
+    return item

docs/tutorial/src/tutorial59.py

@@ -1,59 +1,13 @@
 from typing import List, Set
 
-from fastapi import Body, FastAPI, Path, Query, Depends, Cookie
+from fastapi import Body, FastAPI, Path, Query
 from pydantic import BaseModel
 from pydantic.types import UrlStr
 from starlette.status import HTTP_201_CREATED
-from starlette.responses import HTMLResponse
-from random import choice
 
-from sqlalchemy import create_engine
-from sqlalchemy.orm import scoped_session, sessionmaker
-from sqlalchemy import Column, Integer, DateTime, String, Boolean, ForeignKey
-from sqlalchemy.ext.declarative import declarative_base, declared_attr
-
-
-# SQLAlchemy specific code, as with any other app
-
-
-SQLALCHEMY_DATABASE_URI = "postgresql://user:password@postgresserver/db"
-
-# By creating this a CustomBase class and inheriting from it, your models will have
-# automatic __tablename__ attributes. So you don't have to declare them.
-# So, your models will behave very similarly to, for example, Flask-SQLAlchemy
-
-class CustomBase:
-    # Generate __tablename__ automatically
-    @declared_attr
-    def __tablename__(cls):
-        return cls.__name__.lower()
-
-
-Base = declarative_base(cls=CustomBase)
-
-
-class User(Base):
-    # Own properties
-    id = Column(Integer, primary_key=True, index=True)
-    email = Column(String, unique=True, index=True)
-    hashed_password = Column(String)
-    is_active = Column(Boolean(), default=True)
-
-
-engine = create_engine(SQLALCHEMY_DATABASE_URI, convert_unicode=True)
-db_session = scoped_session(
-    sessionmaker(autocommit=False, autoflush=False, bind=engine)
-)
-
-
-def get_user(username, db_session):
-    return db_session.query(User).filter(User.id == username).first()
-
-# FastAPI specific code
 app = FastAPI()
 
 
-@app.get("/users/{username}")
+@app.get("/items/", deprecated=True)
-def read_user(username: str):
+async def read_items():
-    user = get_user(username, db_session)
+    return [{"item_id": "Foo"}]
-    return user

docs/tutorial/src/tutorial60.py

@@ -1,66 +1,13 @@
 from typing import List, Set
 
-from fastapi import Body, FastAPI, Path, Query, Depends, Cookie
+from fastapi import Body, FastAPI, Path, Query
 from pydantic import BaseModel
 from pydantic.types import UrlStr
 from starlette.status import HTTP_201_CREATED
-from starlette.responses import HTMLResponse
-from random import choice
 
-from typing import List, Optional, Union
-
-from pydantic import BaseModel
-
-from app.models.config import USERPROFILE_DOC_TYPE
-from app.models.role import RoleEnum
-from couchbase.bucket import Bucket
-from couchbase.cluster import Cluster, PasswordAuthenticator
-from couchbase import LOCKMODE_WAIT
-
-
-def get_bucket():
-    cluster = Cluster("couchbase://couchbasehost:8091")
-    authenticator = PasswordAuthenticator("username", "password")
-    cluster.authenticate(authenticator)
-    bucket: Bucket = cluster.open_bucket("bucket_name", lockmode=LOCKMODE_WAIT)
-    return bucket
-
-
-class User(BaseModel):
-    username: str
-    email: Optional[str] = None
-    full_name: Optional[str] = None
-    disabled: Optional[bool] = None
-
-
-class UserInDB(User):
-    type: str = USERPROFILE_DOC_TYPE
-    hashed_password: str
-
-    class Meta:
-        key: Optional[str] = None
-
-
-def get_user_doc_id(username):
-    return f"userprofile::{username}"
-
-
-def get_user(bucket: Bucket, username: str):
-    doc_id = get_user_doc_id(username)
-    result = bucket.get(doc_id, quiet=True)
-    if not result.value:
-        return None
-    user = UserInDB(**result.value)
-    user.Meta.key = result.key
-    return user
-
-
-# FastAPI specific code
 app = FastAPI()
 
 
-@app.get("/users/{username}")
+@app.get("/items/", operation_id="some_specific_id_you_define")
-def read_user(username: str):
+async def read_items():
-    bucket = get_bucket()
+    return [{"item_id": "Foo"}]
-    user = get_user(bucket=bucket, username=username)
-    return user

docs/tutorial/src/tutorial61.py

@@ -0,0 +1,13 @@
+from typing import List, Set
+
+from fastapi import Body, FastAPI, Path, Query
+from pydantic import BaseModel
+from pydantic.types import UrlStr
+from starlette.status import HTTP_201_CREATED
+
+app = FastAPI()
+
+
+@app.get("/items/", include_in_schema=False)
+async def read_items():
+    return [{"item_id": "Foo"}]

docs/tutorial/src/tutorial62.py

@@ -0,0 +1,14 @@
+from typing import List, Set
+
+from fastapi import Body, FastAPI, Path, Query
+from pydantic import BaseModel
+from pydantic.types import UrlStr
+from starlette.status import HTTP_201_CREATED
+from starlette.responses import UJSONResponse
+
+app = FastAPI()
+
+
+@app.get("/items/", content_type=UJSONResponse)
+async def read_items():
+    return [{"item_id": "Foo"}]

docs/tutorial/src/tutorial63.py

@@ -0,0 +1,23 @@
+from typing import List, Set
+
+from fastapi import Body, FastAPI, Path, Query
+from pydantic import BaseModel
+from pydantic.types import UrlStr
+from starlette.status import HTTP_201_CREATED
+from starlette.responses import HTMLResponse
+
+app = FastAPI()
+
+
+@app.get("/items/", content_type=HTMLResponse)
+async def read_items():
+    return """
+    <html>
+        <head>
+            <title>Some HTML in here</title>
+        </head>
+        <body>
+            <h1>Look ma! HTML!</h1>
+        </body>
+    </html>
+    """

docs/tutorial/src/tutorial67.py

@@ -0,0 +1,59 @@
+from typing import List, Set
+
+from fastapi import Body, FastAPI, Path, Query, Depends, Cookie
+from pydantic import BaseModel
+from pydantic.types import UrlStr
+from starlette.status import HTTP_201_CREATED
+from starlette.responses import HTMLResponse
+from random import choice
+
+from sqlalchemy import create_engine
+from sqlalchemy.orm import scoped_session, sessionmaker
+from sqlalchemy import Column, Integer, DateTime, String, Boolean, ForeignKey
+from sqlalchemy.ext.declarative import declarative_base, declared_attr
+
+
+# SQLAlchemy specific code, as with any other app
+
+
+SQLALCHEMY_DATABASE_URI = "postgresql://user:password@postgresserver/db"
+
+# By creating this a CustomBase class and inheriting from it, your models will have
+# automatic __tablename__ attributes. So you don't have to declare them.
+# So, your models will behave very similarly to, for example, Flask-SQLAlchemy
+
+class CustomBase:
+    # Generate __tablename__ automatically
+    @declared_attr
+    def __tablename__(cls):
+        return cls.__name__.lower()
+
+
+Base = declarative_base(cls=CustomBase)
+
+
+class User(Base):
+    # Own properties
+    id = Column(Integer, primary_key=True, index=True)
+    email = Column(String, unique=True, index=True)
+    hashed_password = Column(String)
+    is_active = Column(Boolean(), default=True)
+
+
+engine = create_engine(SQLALCHEMY_DATABASE_URI, convert_unicode=True)
+db_session = scoped_session(
+    sessionmaker(autocommit=False, autoflush=False, bind=engine)
+)
+
+
+def get_user(username, db_session):
+    return db_session.query(User).filter(User.id == username).first()
+
+# FastAPI specific code
+app = FastAPI()
+
+
+@app.get("/users/{username}")
+def read_user(username: str):
+    user = get_user(username, db_session)
+    return user

docs/tutorial/src/tutorial68.py

@@ -0,0 +1,66 @@
+from typing import List, Set
+
+from fastapi import Body, FastAPI, Path, Query, Depends, Cookie
+from pydantic import BaseModel
+from pydantic.types import UrlStr
+from starlette.status import HTTP_201_CREATED
+from starlette.responses import HTMLResponse
+from random import choice
+
+from typing import List, Optional, Union
+
+from pydantic import BaseModel
+
+from app.models.config import USERPROFILE_DOC_TYPE
+from app.models.role import RoleEnum
+from couchbase.bucket import Bucket
+from couchbase.cluster import Cluster, PasswordAuthenticator
+from couchbase import LOCKMODE_WAIT
+
+
+def get_bucket():
+    cluster = Cluster("couchbase://couchbasehost:8091")
+    authenticator = PasswordAuthenticator("username", "password")
+    cluster.authenticate(authenticator)
+    bucket: Bucket = cluster.open_bucket("bucket_name", lockmode=LOCKMODE_WAIT)
+    return bucket
+
+
+class User(BaseModel):
+    username: str
+    email: Optional[str] = None
+    full_name: Optional[str] = None
+    disabled: Optional[bool] = None
+
+
+class UserInDB(User):
+    type: str = USERPROFILE_DOC_TYPE
+    hashed_password: str
+
+    class Meta:
+        key: Optional[str] = None
+
+
+def get_user_doc_id(username):
+    return f"userprofile::{username}"
+
+
+def get_user(bucket: Bucket, username: str):
+    doc_id = get_user_doc_id(username)
+    result = bucket.get(doc_id, quiet=True)
+    if not result.value:
+        return None
+    user = UserInDB(**result.value)
+    user.Meta.key = result.key
+    return user
+
+
+# FastAPI specific code
+app = FastAPI()
+
+
+@app.get("/users/{username}")
+def read_user(username: str):
+    bucket = get_bucket()
+    user = get_user(bucket=bucket, username=username)
+    return user