mirror of
https://github.com/fastapi/fastapi.git
synced 2025-12-25 07:08:11 -05:00
7dad5a820b
* ✨ Update OpenAPI models for JSON Schema 2020-12 and OpenAPI 3.1.0 * ✨ Add support for summary and webhooks * ✨ Update JSON Schema for UploadFiles * ⏪️ Revert making paths optional, to ensure always correctness * ⏪️ Keep UploadFile as format: binary for compatibility with the rest of Pydantic bytes fields in v1 * ✨ Update version of OpenAPI generated to 3.1.0 * ✨ Update the version of Swagger UI * 📝 Update docs about extending OpenAPI * 📝 Update docs and links to refer to OpenAPI 3.1.0 * ✨ Update logic for handling webhooks * ♻️ Update parameter functions and classes, deprecate example and make examples the main field * ✅ Update tests for OpenAPI 3.1.0 * 📝 Update examples for OpenAPI metadata * ✅ Add and update tests for OpenAPI metadata * 📝 Add source example for webhooks * 📝 Update docs for metadata * 📝 Update docs for Schema extra * 📝 Add docs for webhooks * 🔧 Add webhooks docs to MkDocs * ✅ Update tests for extending OpenAPI * ✅ Add tests for webhooks * ♻️ Refactor generation of OpenAPI and JSON Schema with params * 📝 Update source examples for field examples * ✅ Update tests for examples * ➕ Make sure the minimum version of typing-extensions installed has deprecated() (already a dependency of Pydantic) * ✏️ Fix typo in Webhooks example code * 🔥 Remove commented out code of removed nullable field * 🗑️ Add deprecation warnings for example argument * ✅ Update tests to check for deprecation warnings * ✅ Add test for webhooks with security schemes, for coverage * 🍱 Update image for metadata, with new summary * 🍱 Add docs image for Webhooks * 📝 Update docs for webhooks, add docs UI image
73 lines
2.0 KiB
Python
73 lines
2.0 KiB
Python
from typing import Optional
|
|
|
|
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", auto_error=False)
|
|
|
|
|
|
class User(BaseModel):
|
|
username: str
|
|
|
|
|
|
def get_current_user(oauth_header: Optional[str] = Security(api_key)):
|
|
if oauth_header is None:
|
|
return None
|
|
user = User(username=oauth_header)
|
|
return user
|
|
|
|
|
|
@app.get("/users/me")
|
|
def read_current_user(current_user: Optional[User] = Depends(get_current_user)):
|
|
if current_user is None:
|
|
return {"msg": "Create an account first"}
|
|
return current_user
|
|
|
|
|
|
client = TestClient(app)
|
|
|
|
|
|
def test_security_api_key():
|
|
response = client.get("/users/me", headers={"key": "secret"})
|
|
assert response.status_code == 200, response.text
|
|
assert response.json() == {"username": "secret"}
|
|
|
|
|
|
def test_security_api_key_no_key():
|
|
response = client.get("/users/me")
|
|
assert response.status_code == 200, response.text
|
|
assert response.json() == {"msg": "Create an account first"}
|
|
|
|
|
|
def test_openapi_schema():
|
|
response = client.get("/openapi.json")
|
|
assert response.status_code == 200, response.text
|
|
assert response.json() == {
|
|
"openapi": "3.1.0",
|
|
"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"}
|
|
}
|
|
},
|
|
}
|