Browse Source
* ✨ Add Default and DefaultPlaceholder data structures to handle defaults and overrides * ✨ Add utils to get values by priority handling DefaultPlaceholders * ✨ Add support for top-level parameters in FastAPI, APIRouter, include_router including: prefix, tags, dependencies, deprecated, include_in_schema, responses, default_response_class, callbacks * ♻️ Update openapi utils to handle DefaultPlaceholder for response_class * 📝 Update bigger-application example code to use top-level params and showcase them in APIRouter, FastAPI, include_router * 📝 Update docs for Bigger Applications, include diagrams, top-level params * 🔥 Simplify code and docs for callbacks as default_response_class is no longer required * 📝 Add docs for top-level dependencies, in FastAPI() * 📝 Add docs reference to top-level dependencies in docs for decorator * ✅ Update/increase tests for Bigger Applications including shared parameters * ✅ Add tests for top-level dependencies in FastAPI() * ✅ Add tests for internal DefaultPlaceholder * ✅ Update/increase tests for callbacks with top-level parameters * ✅ Add LOTS of tests covering branches and cases for shared parameters in top-level FastAPI, path operations, include_router, APIRouter, its path operations, nested include_router, nested APIRouter, and its path operations * 🎨 Format/reorder parameters for consistency in FastAPI, APIRouter, include_routerpull/2435/head
Sebastián Ramírez
4 years ago
committed by
GitHub
GitHub
26 changed files with 7786 additions and 287 deletions
|
Before Width: | Height: | Size: 76 KiB After Width: | Height: | Size: 73 KiB |
@ -0,0 +1,43 @@ |
|||||
|
<mxfile host="65bd71144e" modified="2020-11-28T18:13:19.199Z" agent="5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) Code/1.51.1 Chrome/83.0.4103.122 Electron/9.3.3 Safari/537.36" etag="KPHuXUeExV3PdWouu_3U" version="13.6.5"> |
||||
|
<diagram id="zB4-QXJZ7ScUzHSLnJ1i" name="Page-1"> |
||||
|
<mxGraphModel dx="1154" dy="780" grid="1" gridSize="10" guides="1" tooltips="1" connect="1" arrows="1" fold="1" page="1" pageScale="1" pageWidth="1920" pageHeight="1200" math="0" shadow="0" extFonts="Roboto^https://fonts.googleapis.com/css?family=Roboto|Roboto Mono, mono^https://fonts.googleapis.com/css?family=Roboto+Mono%2C+mono"> |
||||
|
<root> |
||||
|
<mxCell id="0"/> |
||||
|
<mxCell id="1" parent="0"/> |
||||
|
<mxCell id="2" value="" style="rounded=0;whiteSpace=wrap;html=1;fontStyle=1;strokeWidth=4;" parent="1" vertex="1"> |
||||
|
<mxGeometry x="110" y="280" width="1350" height="620" as="geometry"/> |
||||
|
</mxCell> |
||||
|
<mxCell id="3" value="<font style="font-size: 24px" face="Roboto">Package app<br>app/__init__.py</font>" style="text;html=1;strokeColor=none;fillColor=none;align=center;verticalAlign=middle;whiteSpace=wrap;rounded=0;strokeWidth=3;fontFamily=Roboto Mono, mono;FType=g;" parent="1" vertex="1"> |
||||
|
<mxGeometry x="635" y="310" width="300" height="80" as="geometry"/> |
||||
|
</mxCell> |
||||
|
<mxCell id="15" value="<span style="font-family: &#34;roboto&#34; ; font-size: 24px">Module app.main</span><br style="font-family: &#34;roboto&#34; ; font-size: 24px"><span style="font-family: &#34;roboto&#34; ; font-size: 24px">app/main.py</span>" style="shape=hexagon;perimeter=hexagonPerimeter2;whiteSpace=wrap;html=1;fixedSize=1;strokeWidth=3;" parent="1" vertex="1"> |
||||
|
<mxGeometry x="140" y="430" width="360" height="100" as="geometry"/> |
||||
|
</mxCell> |
||||
|
<mxCell id="16" value="<span style="font-family: &#34;roboto&#34; ; font-size: 24px">Module app.dependencies</span><br style="font-family: &#34;roboto&#34; ; font-size: 24px"><span style="font-family: &#34;roboto&#34; ; font-size: 24px">app/dependencies.py</span>" style="shape=hexagon;perimeter=hexagonPerimeter2;whiteSpace=wrap;html=1;fixedSize=1;strokeWidth=3;" parent="1" vertex="1"> |
||||
|
<mxGeometry x="130" y="565" width="370" height="100" as="geometry"/> |
||||
|
</mxCell> |
||||
|
<mxCell id="5" value="" style="rounded=0;whiteSpace=wrap;html=1;fontStyle=1;strokeWidth=4;" parent="1" vertex="1"> |
||||
|
<mxGeometry x="1030" y="430" width="400" height="260" as="geometry"/> |
||||
|
</mxCell> |
||||
|
<mxCell id="8" value="<font style="font-size: 24px" face="Roboto">Subpackage app.internal<br></font><span style="font-family: &#34;roboto&#34; ; font-size: 24px">app/internal/__init__.py</span><font style="font-size: 24px" face="Roboto"><br></font>" style="text;html=1;strokeColor=none;fillColor=none;align=center;verticalAlign=middle;whiteSpace=wrap;rounded=0;strokeWidth=3;fontFamily=Roboto Mono, mono;FType=g;" parent="1" vertex="1"> |
||||
|
<mxGeometry x="1083.8438461538462" y="460" width="292.3076923076923" height="80" as="geometry"/> |
||||
|
</mxCell> |
||||
|
<mxCell id="19" value="<span style="font-family: &#34;roboto&#34; ; font-size: 24px">Module app.internal.admin</span><br style="font-family: &#34;roboto&#34; ; font-size: 24px"><span style="font-family: &#34;roboto&#34; ; font-size: 24px">app/internal/admin.py</span>" style="shape=hexagon;perimeter=hexagonPerimeter2;whiteSpace=wrap;html=1;fixedSize=1;strokeWidth=3;" parent="1" vertex="1"> |
||||
|
<mxGeometry x="1050" y="570" width="360" height="100" as="geometry"/> |
||||
|
</mxCell> |
||||
|
<mxCell id="4" value="" style="rounded=0;whiteSpace=wrap;html=1;fontStyle=1;strokeWidth=4;" parent="1" vertex="1"> |
||||
|
<mxGeometry x="540" y="430" width="440" height="410" as="geometry"/> |
||||
|
</mxCell> |
||||
|
<mxCell id="7" value="<font style="font-size: 24px" face="Roboto">Subpackage app.routers<br>app/routers/__init__.py<br></font>" style="text;html=1;strokeColor=none;fillColor=none;align=center;verticalAlign=middle;whiteSpace=wrap;rounded=0;strokeWidth=3;fontFamily=Roboto Mono, mono;FType=g;" parent="1" vertex="1"> |
||||
|
<mxGeometry x="599.2307692307693" y="460" width="321.53846153846155" height="80" as="geometry"/> |
||||
|
</mxCell> |
||||
|
<mxCell id="17" value="<span style="font-family: &#34;roboto&#34; ; font-size: 24px">Module app.routers.items</span><br style="font-family: &#34;roboto&#34; ; font-size: 24px"><span style="font-family: &#34;roboto&#34; ; font-size: 24px">app/routers/items.py</span>" style="shape=hexagon;perimeter=hexagonPerimeter2;whiteSpace=wrap;html=1;fixedSize=1;strokeWidth=3;" parent="1" vertex="1"> |
||||
|
<mxGeometry x="580" y="570" width="360" height="100" as="geometry"/> |
||||
|
</mxCell> |
||||
|
<mxCell id="18" value="<span style="font-family: &#34;roboto&#34; ; font-size: 24px">Module app.routers.users</span><br style="font-family: &#34;roboto&#34; ; font-size: 24px"><span style="font-family: &#34;roboto&#34; ; font-size: 24px">app/routers/users.py</span>" style="shape=hexagon;perimeter=hexagonPerimeter2;whiteSpace=wrap;html=1;fixedSize=1;strokeWidth=3;" parent="1" vertex="1"> |
||||
|
<mxGeometry x="580" y="700" width="360" height="100" as="geometry"/> |
||||
|
</mxCell> |
||||
|
</root> |
||||
|
</mxGraphModel> |
||||
|
</diagram> |
||||
|
</mxfile> |
||||
|
After Width: | Height: | Size: 14 KiB |
@ -0,0 +1,17 @@ |
|||||
|
# Global Dependencies |
||||
|
|
||||
|
For some types of applications you might want to add dependencies to the whole application. |
||||
|
|
||||
|
Similar to the way you can [add `dependencies` to the *path operation decorators*](dependencies-in-path-operation-decorators.md){.internal-link target=_blank}, you can add them to the `FastAPI` application. |
||||
|
|
||||
|
In that case, they will be applied to all the *path operations* in the application: |
||||
|
|
||||
|
```Python hl_lines="15" |
||||
|
{!../../../docs_src/dependencies/tutorial012.py!} |
||||
|
``` |
||||
|
|
||||
|
And all the ideas in the section about [adding `dependencies` to the *path operation decorators*](dependencies-in-path-operation-decorators.md){.internal-link target=_blank} still apply, but in this case, to all of the *path operations* in the app. |
||||
|
|
||||
|
## Dependencies for groups of *path operations* |
||||
|
|
||||
|
Later, when reading about how to structure bigger applications ([Bigger Applications - Multiple Files](../../tutorial/bigger-applications.md){.internal-link target=_blank}), possibly with multiple files, you will learn how to declare a single `dependencies` parameter for a group of *path operations*. |
||||
@ -0,0 +1,11 @@ |
|||||
|
from fastapi import Header, HTTPException |
||||
|
|
||||
|
|
||||
|
async def get_token_header(x_token: str = Header(...)): |
||||
|
if x_token != "fake-super-secret-token": |
||||
|
raise HTTPException(status_code=400, detail="X-Token header invalid") |
||||
|
|
||||
|
|
||||
|
async def get_query_token(token: str): |
||||
|
if token != "jessica": |
||||
|
raise HTTPException(status_code=400, detail="No Jessica token provided") |
||||
@ -0,0 +1,8 @@ |
|||||
|
from fastapi import APIRouter |
||||
|
|
||||
|
router = APIRouter() |
||||
|
|
||||
|
|
||||
|
@router.post("/") |
||||
|
async def update_admin(): |
||||
|
return {"message": "Admin getting schwifty"} |
||||
@ -1,20 +1,23 @@ |
|||||
from fastapi import Depends, FastAPI, Header, HTTPException |
from fastapi import Depends, FastAPI |
||||
|
|
||||
|
from .dependencies import get_query_token, get_token_header |
||||
|
from .internal import admin |
||||
from .routers import items, users |
from .routers import items, users |
||||
|
|
||||
app = FastAPI() |
app = FastAPI(dependencies=[Depends(get_query_token)]) |
||||
|
|
||||
|
|
||||
async def get_token_header(x_token: str = Header(...)): |
|
||||
if x_token != "fake-super-secret-token": |
|
||||
raise HTTPException(status_code=400, detail="X-Token header invalid") |
|
||||
|
|
||||
|
|
||||
app.include_router(users.router) |
app.include_router(users.router) |
||||
|
app.include_router(items.router) |
||||
app.include_router( |
app.include_router( |
||||
items.router, |
admin.router, |
||||
prefix="/items", |
prefix="/admin", |
||||
tags=["items"], |
tags=["admin"], |
||||
dependencies=[Depends(get_token_header)], |
dependencies=[Depends(get_token_header)], |
||||
responses={404: {"description": "Not found"}}, |
responses={418: {"description": "I'm a teapot"}}, |
||||
) |
) |
||||
|
|
||||
|
|
||||
|
@app.get("/") |
||||
|
async def root(): |
||||
|
return {"message": "Hello Bigger Applications!"} |
||||
|
|||||
@ -0,0 +1,25 @@ |
|||||
|
from fastapi import Depends, FastAPI, Header, HTTPException |
||||
|
|
||||
|
|
||||
|
async def verify_token(x_token: str = Header(...)): |
||||
|
if x_token != "fake-super-secret-token": |
||||
|
raise HTTPException(status_code=400, detail="X-Token header invalid") |
||||
|
|
||||
|
|
||||
|
async def verify_key(x_key: str = Header(...)): |
||||
|
if x_key != "fake-super-secret-key": |
||||
|
raise HTTPException(status_code=400, detail="X-Key header invalid") |
||||
|
return x_key |
||||
|
|
||||
|
|
||||
|
app = FastAPI(dependencies=[Depends(verify_token), Depends(verify_key)]) |
||||
|
|
||||
|
|
||||
|
@app.get("/items/") |
||||
|
async def read_items(): |
||||
|
return [{"item": "Portal Gun"}, {"item": "Plumbus"}] |
||||
|
|
||||
|
|
||||
|
@app.get("/users/") |
||||
|
async def read_users(): |
||||
|
return [{"username": "Rick"}, {"username": "Morty"}] |
||||
@ -1,7 +1,22 @@ |
|||||
import pytest |
import pytest |
||||
from fastapi import UploadFile |
from fastapi import UploadFile |
||||
|
from fastapi.datastructures import Default |
||||
|
|
||||
|
|
||||
def test_upload_file_invalid(): |
def test_upload_file_invalid(): |
||||
with pytest.raises(ValueError): |
with pytest.raises(ValueError): |
||||
UploadFile.validate("not a Starlette UploadFile") |
UploadFile.validate("not a Starlette UploadFile") |
||||
|
|
||||
|
|
||||
|
def test_default_placeholder_equals(): |
||||
|
placeholder_1 = Default("a") |
||||
|
placeholder_2 = Default("a") |
||||
|
assert placeholder_1 == placeholder_2 |
||||
|
assert placeholder_1.value == placeholder_2.value |
||||
|
|
||||
|
|
||||
|
def test_default_placeholder_bool(): |
||||
|
placeholder_a = Default("a") |
||||
|
placeholder_b = Default("") |
||||
|
assert placeholder_a |
||||
|
assert not placeholder_b |
||||
|
|||||
File diff suppressed because it is too large
@ -0,0 +1,209 @@ |
|||||
|
from fastapi.testclient import TestClient |
||||
|
|
||||
|
from docs_src.dependencies.tutorial012 import app |
||||
|
|
||||
|
client = TestClient(app) |
||||
|
|
||||
|
openapi_schema = { |
||||
|
"openapi": "3.0.2", |
||||
|
"info": {"title": "FastAPI", "version": "0.1.0"}, |
||||
|
"paths": { |
||||
|
"/items/": { |
||||
|
"get": { |
||||
|
"summary": "Read Items", |
||||
|
"operationId": "read_items_items__get", |
||||
|
"parameters": [ |
||||
|
{ |
||||
|
"required": True, |
||||
|
"schema": {"title": "X-Token", "type": "string"}, |
||||
|
"name": "x-token", |
||||
|
"in": "header", |
||||
|
}, |
||||
|
{ |
||||
|
"required": True, |
||||
|
"schema": {"title": "X-Key", "type": "string"}, |
||||
|
"name": "x-key", |
||||
|
"in": "header", |
||||
|
}, |
||||
|
], |
||||
|
"responses": { |
||||
|
"200": { |
||||
|
"description": "Successful Response", |
||||
|
"content": {"application/json": {"schema": {}}}, |
||||
|
}, |
||||
|
"422": { |
||||
|
"description": "Validation Error", |
||||
|
"content": { |
||||
|
"application/json": { |
||||
|
"schema": { |
||||
|
"$ref": "#/components/schemas/HTTPValidationError" |
||||
|
} |
||||
|
} |
||||
|
}, |
||||
|
}, |
||||
|
}, |
||||
|
} |
||||
|
}, |
||||
|
"/users/": { |
||||
|
"get": { |
||||
|
"summary": "Read Users", |
||||
|
"operationId": "read_users_users__get", |
||||
|
"parameters": [ |
||||
|
{ |
||||
|
"required": True, |
||||
|
"schema": {"title": "X-Token", "type": "string"}, |
||||
|
"name": "x-token", |
||||
|
"in": "header", |
||||
|
}, |
||||
|
{ |
||||
|
"required": True, |
||||
|
"schema": {"title": "X-Key", "type": "string"}, |
||||
|
"name": "x-key", |
||||
|
"in": "header", |
||||
|
}, |
||||
|
], |
||||
|
"responses": { |
||||
|
"200": { |
||||
|
"description": "Successful Response", |
||||
|
"content": {"application/json": {"schema": {}}}, |
||||
|
}, |
||||
|
"422": { |
||||
|
"description": "Validation Error", |
||||
|
"content": { |
||||
|
"application/json": { |
||||
|
"schema": { |
||||
|
"$ref": "#/components/schemas/HTTPValidationError" |
||||
|
} |
||||
|
} |
||||
|
}, |
||||
|
}, |
||||
|
}, |
||||
|
} |
||||
|
}, |
||||
|
}, |
||||
|
"components": { |
||||
|
"schemas": { |
||||
|
"HTTPValidationError": { |
||||
|
"title": "HTTPValidationError", |
||||
|
"type": "object", |
||||
|
"properties": { |
||||
|
"detail": { |
||||
|
"title": "Detail", |
||||
|
"type": "array", |
||||
|
"items": {"$ref": "#/components/schemas/ValidationError"}, |
||||
|
} |
||||
|
}, |
||||
|
}, |
||||
|
"ValidationError": { |
||||
|
"title": "ValidationError", |
||||
|
"required": ["loc", "msg", "type"], |
||||
|
"type": "object", |
||||
|
"properties": { |
||||
|
"loc": { |
||||
|
"title": "Location", |
||||
|
"type": "array", |
||||
|
"items": {"type": "string"}, |
||||
|
}, |
||||
|
"msg": {"title": "Message", "type": "string"}, |
||||
|
"type": {"title": "Error Type", "type": "string"}, |
||||
|
}, |
||||
|
}, |
||||
|
} |
||||
|
}, |
||||
|
} |
||||
|
|
||||
|
|
||||
|
def test_openapi_schema(): |
||||
|
response = client.get("/openapi.json") |
||||
|
assert response.status_code == 200, response.text |
||||
|
assert response.json() == openapi_schema |
||||
|
|
||||
|
|
||||
|
def test_get_no_headers_items(): |
||||
|
response = client.get("/items/") |
||||
|
assert response.status_code == 422, response.text |
||||
|
assert response.json() == { |
||||
|
"detail": [ |
||||
|
{ |
||||
|
"loc": ["header", "x-token"], |
||||
|
"msg": "field required", |
||||
|
"type": "value_error.missing", |
||||
|
}, |
||||
|
{ |
||||
|
"loc": ["header", "x-key"], |
||||
|
"msg": "field required", |
||||
|
"type": "value_error.missing", |
||||
|
}, |
||||
|
] |
||||
|
} |
||||
|
|
||||
|
|
||||
|
def test_get_no_headers_users(): |
||||
|
response = client.get("/users/") |
||||
|
assert response.status_code == 422, response.text |
||||
|
assert response.json() == { |
||||
|
"detail": [ |
||||
|
{ |
||||
|
"loc": ["header", "x-token"], |
||||
|
"msg": "field required", |
||||
|
"type": "value_error.missing", |
||||
|
}, |
||||
|
{ |
||||
|
"loc": ["header", "x-key"], |
||||
|
"msg": "field required", |
||||
|
"type": "value_error.missing", |
||||
|
}, |
||||
|
] |
||||
|
} |
||||
|
|
||||
|
|
||||
|
def test_get_invalid_one_header_items(): |
||||
|
response = client.get("/items/", headers={"X-Token": "invalid"}) |
||||
|
assert response.status_code == 400, response.text |
||||
|
assert response.json() == {"detail": "X-Token header invalid"} |
||||
|
|
||||
|
|
||||
|
def test_get_invalid_one_users(): |
||||
|
response = client.get("/users/", headers={"X-Token": "invalid"}) |
||||
|
assert response.status_code == 400, response.text |
||||
|
assert response.json() == {"detail": "X-Token header invalid"} |
||||
|
|
||||
|
|
||||
|
def test_get_invalid_second_header_items(): |
||||
|
response = client.get( |
||||
|
"/items/", headers={"X-Token": "fake-super-secret-token", "X-Key": "invalid"} |
||||
|
) |
||||
|
assert response.status_code == 400, response.text |
||||
|
assert response.json() == {"detail": "X-Key header invalid"} |
||||
|
|
||||
|
|
||||
|
def test_get_invalid_second_header_users(): |
||||
|
response = client.get( |
||||
|
"/users/", headers={"X-Token": "fake-super-secret-token", "X-Key": "invalid"} |
||||
|
) |
||||
|
assert response.status_code == 400, response.text |
||||
|
assert response.json() == {"detail": "X-Key header invalid"} |
||||
|
|
||||
|
|
||||
|
def test_get_valid_headers_items(): |
||||
|
response = client.get( |
||||
|
"/items/", |
||||
|
headers={ |
||||
|
"X-Token": "fake-super-secret-token", |
||||
|
"X-Key": "fake-super-secret-key", |
||||
|
}, |
||||
|
) |
||||
|
assert response.status_code == 200, response.text |
||||
|
assert response.json() == [{"item": "Portal Gun"}, {"item": "Plumbus"}] |
||||
|
|
||||
|
|
||||
|
def test_get_valid_headers_users(): |
||||
|
response = client.get( |
||||
|
"/users/", |
||||
|
headers={ |
||||
|
"X-Token": "fake-super-secret-token", |
||||
|
"X-Key": "fake-super-secret-key", |
||||
|
}, |
||||
|
) |
||||
|
assert response.status_code == 200, response.text |
||||
|
assert response.json() == [{"username": "Rick"}, {"username": "Morty"}] |
||||
Loading…
Reference in new issue