mirror of
https://github.com/fastapi/fastapi.git
synced 2025-12-30 17:50:39 -05:00
1f01ce9615
* Updated .py files with Optional tag (up to body_nested_models) * Update optionals * docs_src/ all updates, few I was unsure of * Updated markdown files with Optional param * es: Add Optional typing to index.md * Last of markdown files updated with Optional param * Update highlight lines * it: Add Optional typings * README.md: Update with Optional typings * Update more highlight increments * Update highlights * schema-extra-example.md: Update highlights * updating highlighting on website to reflect .py changes * Update highlighting for query-params & response-directly * Address PR comments * Get rid of unnecessary comment * ⏪ Revert Optional in Chinese docs as it probably also requires changes in text * 🎨 Apply format * ⏪ Revert modified example * ♻️ Simplify example in docs * 📝 Update OpenAPI callback example to use Optional * ✨ Add Optional types to tests * 📝 Update docs about query params, default to using Optional * 🎨 Update code examples line highlighting * 📝 Update nested models docs to use "type parameters" instead of "subtypes" * 📝 Add notes about FastAPI usage of None including: = None and = Query(None) and clarify relationship with Optional[str] * 📝 Add note about response_model_by_alias * ♻️ Simplify query param list example * 🔥 Remove test for removed example * ✅ Update test for updated example Co-authored-by: Christopher Nguyen <chrisngyn99@gmail.com> Co-authored-by: yk396 <yk396@cornell.edu> Co-authored-by: Kai Chen <kaichen120@gmail.com>
39 lines
1.1 KiB
Python
39 lines
1.1 KiB
Python
from typing import Optional
|
|
|
|
from fastapi import FastAPI, Header, HTTPException
|
|
from pydantic import BaseModel
|
|
|
|
fake_secret_token = "coneofsilence"
|
|
|
|
fake_db = {
|
|
"foo": {"id": "foo", "title": "Foo", "description": "There goes my hero"},
|
|
"bar": {"id": "bar", "title": "Bar", "description": "The bartenders"},
|
|
}
|
|
|
|
app = FastAPI()
|
|
|
|
|
|
class Item(BaseModel):
|
|
id: str
|
|
title: str
|
|
description: Optional[str] = None
|
|
|
|
|
|
@app.get("/items/{item_id}", response_model=Item)
|
|
async def read_main(item_id: str, x_token: str = Header(...)):
|
|
if x_token != fake_secret_token:
|
|
raise HTTPException(status_code=400, detail="Invalid X-Token header")
|
|
if item_id not in fake_db:
|
|
raise HTTPException(status_code=404, detail="Item not found")
|
|
return fake_db[item_id]
|
|
|
|
|
|
@app.post("/items/", response_model=Item)
|
|
async def create_item(item: Item, x_token: str = Header(...)):
|
|
if x_token != fake_secret_token:
|
|
raise HTTPException(status_code=400, detail="Invalid X-Token header")
|
|
if item.id in fake_db:
|
|
raise HTTPException(status_code=400, detail="Item already exists")
|
|
fake_db[item.id] = item
|
|
return item
|