mirror of
https://github.com/fastapi/fastapi.git
synced 2026-01-20 03:48:04 -05:00
0ac9b3ee5c
* ✨ Re-export main features used from Starlette to simplify developer's code * ♻️ Refactor Starlette exports * ♻️ Refactor tutorial examples to use re-exported utils from Starlette * 📝 Add examples for all middlewares * 📝 Add new docs for middlewares * 📝 Add examples for custom responses * 📝 Extend docs for custom responses * 📝 Update docs and add notes explaining re-exports from Starlette everywhere * 🍱 Update screenshot for HTTP status * 🔧 Update MkDocs config with new content * ♻️ Refactor tests to use re-exported utils from Starlette * ✨ Re-export WebSocketDisconnect from Starlette for tests * ✅ Add extra tests for extra re-exported middleware * ✅ Add tests for re-exported responses from Starlette * ✨ Add docs about mounting WSGI apps * ➕ Add Flask as a dependency to test WSGIMiddleware * ✅ Test WSGIMiddleware example
69 lines
1.7 KiB
Python
69 lines
1.7 KiB
Python
from fastapi import Depends, FastAPI, Security
|
|
from fastapi.security import APIKeyHeader
|
|
from fastapi.testclient import TestClient
|
|
from pydantic import BaseModel
|
|
|
|
app = FastAPI()
|
|
|
|
api_key = APIKeyHeader(name="key")
|
|
|
|
|
|
class User(BaseModel):
|
|
username: str
|
|
|
|
|
|
def get_current_user(oauth_header: str = Security(api_key)):
|
|
user = User(username=oauth_header)
|
|
return user
|
|
|
|
|
|
@app.get("/users/me")
|
|
def read_current_user(current_user: User = Depends(get_current_user)):
|
|
return current_user
|
|
|
|
|
|
client = TestClient(app)
|
|
|
|
openapi_schema = {
|
|
"openapi": "3.0.2",
|
|
"info": {"title": "FastAPI", "version": "0.1.0"},
|
|
"paths": {
|
|
"/users/me": {
|
|
"get": {
|
|
"responses": {
|
|
"200": {
|
|
"description": "Successful Response",
|
|
"content": {"application/json": {"schema": {}}},
|
|
}
|
|
},
|
|
"summary": "Read Current User",
|
|
"operationId": "read_current_user_users_me_get",
|
|
"security": [{"APIKeyHeader": []}],
|
|
}
|
|
}
|
|
},
|
|
"components": {
|
|
"securitySchemes": {
|
|
"APIKeyHeader": {"type": "apiKey", "name": "key", "in": "header"}
|
|
}
|
|
},
|
|
}
|
|
|
|
|
|
def test_openapi_schema():
|
|
response = client.get("/openapi.json")
|
|
assert response.status_code == 200
|
|
assert response.json() == openapi_schema
|
|
|
|
|
|
def test_security_api_key():
|
|
response = client.get("/users/me", headers={"key": "secret"})
|
|
assert response.status_code == 200
|
|
assert response.json() == {"username": "secret"}
|
|
|
|
|
|
def test_security_api_key_no_key():
|
|
response = client.get("/users/me")
|
|
assert response.status_code == 403
|
|
assert response.json() == {"detail": "Not authenticated"}
|