Browse Source
* ♻️ Refactor model for OpenAPI Examples to use a reusable TypedDict * ✨ Add support for openapi_examples in parameters * 📝 Add new docs examples for new parameter openapi_examples * 📝 Update docs for Schema Extra to include OpenAPI examples * ✅ Add tests for new source examples, for openapi_examples * ✅ Add tests for openapi_examples corner cases and all parameters * 💡 Tweak and ignore type annotation checks for custom TypedDictpull/10164/head
Sebastián Ramírez
2 years ago
committed by
GitHub
GitHub
16 changed files with 1695 additions and 28 deletions
@ -0,0 +1,51 @@ |
|||
from typing import Union |
|||
|
|||
from fastapi import Body, FastAPI |
|||
from pydantic import BaseModel |
|||
|
|||
app = FastAPI() |
|||
|
|||
|
|||
class Item(BaseModel): |
|||
name: str |
|||
description: Union[str, None] = None |
|||
price: float |
|||
tax: Union[float, None] = None |
|||
|
|||
|
|||
@app.put("/items/{item_id}") |
|||
async def update_item( |
|||
*, |
|||
item_id: int, |
|||
item: Item = Body( |
|||
openapi_examples={ |
|||
"normal": { |
|||
"summary": "A normal example", |
|||
"description": "A **normal** item works correctly.", |
|||
"value": { |
|||
"name": "Foo", |
|||
"description": "A very nice Item", |
|||
"price": 35.4, |
|||
"tax": 3.2, |
|||
}, |
|||
}, |
|||
"converted": { |
|||
"summary": "An example with converted data", |
|||
"description": "FastAPI can convert price `strings` to actual `numbers` automatically", |
|||
"value": { |
|||
"name": "Bar", |
|||
"price": "35.4", |
|||
}, |
|||
}, |
|||
"invalid": { |
|||
"summary": "Invalid data is rejected with an error", |
|||
"value": { |
|||
"name": "Baz", |
|||
"price": "thirty five point four", |
|||
}, |
|||
}, |
|||
}, |
|||
), |
|||
): |
|||
results = {"item_id": item_id, "item": item} |
|||
return results |
|||
@ -0,0 +1,55 @@ |
|||
from typing import Union |
|||
|
|||
from fastapi import Body, FastAPI |
|||
from pydantic import BaseModel |
|||
from typing_extensions import Annotated |
|||
|
|||
app = FastAPI() |
|||
|
|||
|
|||
class Item(BaseModel): |
|||
name: str |
|||
description: Union[str, None] = None |
|||
price: float |
|||
tax: Union[float, None] = None |
|||
|
|||
|
|||
@app.put("/items/{item_id}") |
|||
async def update_item( |
|||
*, |
|||
item_id: int, |
|||
item: Annotated[ |
|||
Item, |
|||
Body( |
|||
openapi_examples={ |
|||
"normal": { |
|||
"summary": "A normal example", |
|||
"description": "A **normal** item works correctly.", |
|||
"value": { |
|||
"name": "Foo", |
|||
"description": "A very nice Item", |
|||
"price": 35.4, |
|||
"tax": 3.2, |
|||
}, |
|||
}, |
|||
"converted": { |
|||
"summary": "An example with converted data", |
|||
"description": "FastAPI can convert price `strings` to actual `numbers` automatically", |
|||
"value": { |
|||
"name": "Bar", |
|||
"price": "35.4", |
|||
}, |
|||
}, |
|||
"invalid": { |
|||
"summary": "Invalid data is rejected with an error", |
|||
"value": { |
|||
"name": "Baz", |
|||
"price": "thirty five point four", |
|||
}, |
|||
}, |
|||
}, |
|||
), |
|||
], |
|||
): |
|||
results = {"item_id": item_id, "item": item} |
|||
return results |
|||
@ -0,0 +1,54 @@ |
|||
from typing import Annotated |
|||
|
|||
from fastapi import Body, FastAPI |
|||
from pydantic import BaseModel |
|||
|
|||
app = FastAPI() |
|||
|
|||
|
|||
class Item(BaseModel): |
|||
name: str |
|||
description: str | None = None |
|||
price: float |
|||
tax: float | None = None |
|||
|
|||
|
|||
@app.put("/items/{item_id}") |
|||
async def update_item( |
|||
*, |
|||
item_id: int, |
|||
item: Annotated[ |
|||
Item, |
|||
Body( |
|||
openapi_examples={ |
|||
"normal": { |
|||
"summary": "A normal example", |
|||
"description": "A **normal** item works correctly.", |
|||
"value": { |
|||
"name": "Foo", |
|||
"description": "A very nice Item", |
|||
"price": 35.4, |
|||
"tax": 3.2, |
|||
}, |
|||
}, |
|||
"converted": { |
|||
"summary": "An example with converted data", |
|||
"description": "FastAPI can convert price `strings` to actual `numbers` automatically", |
|||
"value": { |
|||
"name": "Bar", |
|||
"price": "35.4", |
|||
}, |
|||
}, |
|||
"invalid": { |
|||
"summary": "Invalid data is rejected with an error", |
|||
"value": { |
|||
"name": "Baz", |
|||
"price": "thirty five point four", |
|||
}, |
|||
}, |
|||
}, |
|||
), |
|||
], |
|||
): |
|||
results = {"item_id": item_id, "item": item} |
|||
return results |
|||
@ -0,0 +1,54 @@ |
|||
from typing import Annotated, Union |
|||
|
|||
from fastapi import Body, FastAPI |
|||
from pydantic import BaseModel |
|||
|
|||
app = FastAPI() |
|||
|
|||
|
|||
class Item(BaseModel): |
|||
name: str |
|||
description: Union[str, None] = None |
|||
price: float |
|||
tax: Union[float, None] = None |
|||
|
|||
|
|||
@app.put("/items/{item_id}") |
|||
async def update_item( |
|||
*, |
|||
item_id: int, |
|||
item: Annotated[ |
|||
Item, |
|||
Body( |
|||
openapi_examples={ |
|||
"normal": { |
|||
"summary": "A normal example", |
|||
"description": "A **normal** item works correctly.", |
|||
"value": { |
|||
"name": "Foo", |
|||
"description": "A very nice Item", |
|||
"price": 35.4, |
|||
"tax": 3.2, |
|||
}, |
|||
}, |
|||
"converted": { |
|||
"summary": "An example with converted data", |
|||
"description": "FastAPI can convert price `strings` to actual `numbers` automatically", |
|||
"value": { |
|||
"name": "Bar", |
|||
"price": "35.4", |
|||
}, |
|||
}, |
|||
"invalid": { |
|||
"summary": "Invalid data is rejected with an error", |
|||
"value": { |
|||
"name": "Baz", |
|||
"price": "thirty five point four", |
|||
}, |
|||
}, |
|||
}, |
|||
), |
|||
], |
|||
): |
|||
results = {"item_id": item_id, "item": item} |
|||
return results |
|||
@ -0,0 +1,49 @@ |
|||
from fastapi import Body, FastAPI |
|||
from pydantic import BaseModel |
|||
|
|||
app = FastAPI() |
|||
|
|||
|
|||
class Item(BaseModel): |
|||
name: str |
|||
description: str | None = None |
|||
price: float |
|||
tax: float | None = None |
|||
|
|||
|
|||
@app.put("/items/{item_id}") |
|||
async def update_item( |
|||
*, |
|||
item_id: int, |
|||
item: Item = Body( |
|||
openapi_examples={ |
|||
"normal": { |
|||
"summary": "A normal example", |
|||
"description": "A **normal** item works correctly.", |
|||
"value": { |
|||
"name": "Foo", |
|||
"description": "A very nice Item", |
|||
"price": 35.4, |
|||
"tax": 3.2, |
|||
}, |
|||
}, |
|||
"converted": { |
|||
"summary": "An example with converted data", |
|||
"description": "FastAPI can convert price `strings` to actual `numbers` automatically", |
|||
"value": { |
|||
"name": "Bar", |
|||
"price": "35.4", |
|||
}, |
|||
}, |
|||
"invalid": { |
|||
"summary": "Invalid data is rejected with an error", |
|||
"value": { |
|||
"name": "Baz", |
|||
"price": "thirty five point four", |
|||
}, |
|||
}, |
|||
}, |
|||
), |
|||
): |
|||
results = {"item_id": item_id, "item": item} |
|||
return results |
|||
@ -0,0 +1,455 @@ |
|||
from typing import Union |
|||
|
|||
from dirty_equals import IsDict |
|||
from fastapi import Body, Cookie, FastAPI, Header, Path, Query |
|||
from fastapi.testclient import TestClient |
|||
from pydantic import BaseModel |
|||
|
|||
app = FastAPI() |
|||
|
|||
|
|||
class Item(BaseModel): |
|||
data: str |
|||
|
|||
|
|||
@app.post("/examples/") |
|||
def examples( |
|||
item: Item = Body( |
|||
examples=[ |
|||
{"data": "Data in Body examples, example1"}, |
|||
], |
|||
openapi_examples={ |
|||
"Example One": { |
|||
"summary": "Example One Summary", |
|||
"description": "Example One Description", |
|||
"value": {"data": "Data in Body examples, example1"}, |
|||
}, |
|||
"Example Two": { |
|||
"value": {"data": "Data in Body examples, example2"}, |
|||
}, |
|||
}, |
|||
) |
|||
): |
|||
return item |
|||
|
|||
|
|||
@app.get("/path_examples/{item_id}") |
|||
def path_examples( |
|||
item_id: str = Path( |
|||
examples=[ |
|||
"json_schema_item_1", |
|||
"json_schema_item_2", |
|||
], |
|||
openapi_examples={ |
|||
"Path One": { |
|||
"summary": "Path One Summary", |
|||
"description": "Path One Description", |
|||
"value": "item_1", |
|||
}, |
|||
"Path Two": { |
|||
"value": "item_2", |
|||
}, |
|||
}, |
|||
), |
|||
): |
|||
return item_id |
|||
|
|||
|
|||
@app.get("/query_examples/") |
|||
def query_examples( |
|||
data: Union[str, None] = Query( |
|||
default=None, |
|||
examples=[ |
|||
"json_schema_query1", |
|||
"json_schema_query2", |
|||
], |
|||
openapi_examples={ |
|||
"Query One": { |
|||
"summary": "Query One Summary", |
|||
"description": "Query One Description", |
|||
"value": "query1", |
|||
}, |
|||
"Query Two": { |
|||
"value": "query2", |
|||
}, |
|||
}, |
|||
), |
|||
): |
|||
return data |
|||
|
|||
|
|||
@app.get("/header_examples/") |
|||
def header_examples( |
|||
data: Union[str, None] = Header( |
|||
default=None, |
|||
examples=[ |
|||
"json_schema_header1", |
|||
"json_schema_header2", |
|||
], |
|||
openapi_examples={ |
|||
"Header One": { |
|||
"summary": "Header One Summary", |
|||
"description": "Header One Description", |
|||
"value": "header1", |
|||
}, |
|||
"Header Two": { |
|||
"value": "header2", |
|||
}, |
|||
}, |
|||
), |
|||
): |
|||
return data |
|||
|
|||
|
|||
@app.get("/cookie_examples/") |
|||
def cookie_examples( |
|||
data: Union[str, None] = Cookie( |
|||
default=None, |
|||
examples=["json_schema_cookie1", "json_schema_cookie2"], |
|||
openapi_examples={ |
|||
"Cookie One": { |
|||
"summary": "Cookie One Summary", |
|||
"description": "Cookie One Description", |
|||
"value": "cookie1", |
|||
}, |
|||
"Cookie Two": { |
|||
"value": "cookie2", |
|||
}, |
|||
}, |
|||
), |
|||
): |
|||
return data |
|||
|
|||
|
|||
client = TestClient(app) |
|||
|
|||
|
|||
def test_call_api(): |
|||
response = client.get("/path_examples/foo") |
|||
assert response.status_code == 200, response.text |
|||
|
|||
response = client.get("/query_examples/") |
|||
assert response.status_code == 200, response.text |
|||
|
|||
response = client.get("/header_examples/") |
|||
assert response.status_code == 200, response.text |
|||
|
|||
response = client.get("/cookie_examples/") |
|||
assert response.status_code == 200, response.text |
|||
|
|||
|
|||
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": { |
|||
"/examples/": { |
|||
"post": { |
|||
"summary": "Examples", |
|||
"operationId": "examples_examples__post", |
|||
"requestBody": { |
|||
"content": { |
|||
"application/json": { |
|||
"schema": { |
|||
"allOf": [{"$ref": "#/components/schemas/Item"}], |
|||
"title": "Item", |
|||
"examples": [ |
|||
{"data": "Data in Body examples, example1"} |
|||
], |
|||
}, |
|||
"examples": { |
|||
"Example One": { |
|||
"summary": "Example One Summary", |
|||
"description": "Example One Description", |
|||
"value": { |
|||
"data": "Data in Body examples, example1" |
|||
}, |
|||
}, |
|||
"Example Two": { |
|||
"value": { |
|||
"data": "Data in Body examples, example2" |
|||
} |
|||
}, |
|||
}, |
|||
} |
|||
}, |
|||
"required": True, |
|||
}, |
|||
"responses": { |
|||
"200": { |
|||
"description": "Successful Response", |
|||
"content": {"application/json": {"schema": {}}}, |
|||
}, |
|||
"422": { |
|||
"description": "Validation Error", |
|||
"content": { |
|||
"application/json": { |
|||
"schema": { |
|||
"$ref": "#/components/schemas/HTTPValidationError" |
|||
} |
|||
} |
|||
}, |
|||
}, |
|||
}, |
|||
} |
|||
}, |
|||
"/path_examples/{item_id}": { |
|||
"get": { |
|||
"summary": "Path Examples", |
|||
"operationId": "path_examples_path_examples__item_id__get", |
|||
"parameters": [ |
|||
{ |
|||
"name": "item_id", |
|||
"in": "path", |
|||
"required": True, |
|||
"schema": { |
|||
"type": "string", |
|||
"examples": [ |
|||
"json_schema_item_1", |
|||
"json_schema_item_2", |
|||
], |
|||
"title": "Item Id", |
|||
}, |
|||
"examples": { |
|||
"Path One": { |
|||
"summary": "Path One Summary", |
|||
"description": "Path One Description", |
|||
"value": "item_1", |
|||
}, |
|||
"Path Two": {"value": "item_2"}, |
|||
}, |
|||
} |
|||
], |
|||
"responses": { |
|||
"200": { |
|||
"description": "Successful Response", |
|||
"content": {"application/json": {"schema": {}}}, |
|||
}, |
|||
"422": { |
|||
"description": "Validation Error", |
|||
"content": { |
|||
"application/json": { |
|||
"schema": { |
|||
"$ref": "#/components/schemas/HTTPValidationError" |
|||
} |
|||
} |
|||
}, |
|||
}, |
|||
}, |
|||
} |
|||
}, |
|||
"/query_examples/": { |
|||
"get": { |
|||
"summary": "Query Examples", |
|||
"operationId": "query_examples_query_examples__get", |
|||
"parameters": [ |
|||
{ |
|||
"name": "data", |
|||
"in": "query", |
|||
"required": False, |
|||
"schema": IsDict( |
|||
{ |
|||
"anyOf": [{"type": "string"}, {"type": "null"}], |
|||
"examples": [ |
|||
"json_schema_query1", |
|||
"json_schema_query2", |
|||
], |
|||
"title": "Data", |
|||
} |
|||
) |
|||
| IsDict( |
|||
# TODO: remove when deprecating Pydantic v1 |
|||
{ |
|||
"examples": [ |
|||
"json_schema_query1", |
|||
"json_schema_query2", |
|||
], |
|||
"type": "string", |
|||
"title": "Data", |
|||
} |
|||
), |
|||
"examples": { |
|||
"Query One": { |
|||
"summary": "Query One Summary", |
|||
"description": "Query One Description", |
|||
"value": "query1", |
|||
}, |
|||
"Query Two": {"value": "query2"}, |
|||
}, |
|||
} |
|||
], |
|||
"responses": { |
|||
"200": { |
|||
"description": "Successful Response", |
|||
"content": {"application/json": {"schema": {}}}, |
|||
}, |
|||
"422": { |
|||
"description": "Validation Error", |
|||
"content": { |
|||
"application/json": { |
|||
"schema": { |
|||
"$ref": "#/components/schemas/HTTPValidationError" |
|||
} |
|||
} |
|||
}, |
|||
}, |
|||
}, |
|||
} |
|||
}, |
|||
"/header_examples/": { |
|||
"get": { |
|||
"summary": "Header Examples", |
|||
"operationId": "header_examples_header_examples__get", |
|||
"parameters": [ |
|||
{ |
|||
"name": "data", |
|||
"in": "header", |
|||
"required": False, |
|||
"schema": IsDict( |
|||
{ |
|||
"anyOf": [{"type": "string"}, {"type": "null"}], |
|||
"examples": [ |
|||
"json_schema_header1", |
|||
"json_schema_header2", |
|||
], |
|||
"title": "Data", |
|||
} |
|||
) |
|||
| IsDict( |
|||
# TODO: remove when deprecating Pydantic v1 |
|||
{ |
|||
"type": "string", |
|||
"examples": [ |
|||
"json_schema_header1", |
|||
"json_schema_header2", |
|||
], |
|||
"title": "Data", |
|||
} |
|||
), |
|||
"examples": { |
|||
"Header One": { |
|||
"summary": "Header One Summary", |
|||
"description": "Header One Description", |
|||
"value": "header1", |
|||
}, |
|||
"Header Two": {"value": "header2"}, |
|||
}, |
|||
} |
|||
], |
|||
"responses": { |
|||
"200": { |
|||
"description": "Successful Response", |
|||
"content": {"application/json": {"schema": {}}}, |
|||
}, |
|||
"422": { |
|||
"description": "Validation Error", |
|||
"content": { |
|||
"application/json": { |
|||
"schema": { |
|||
"$ref": "#/components/schemas/HTTPValidationError" |
|||
} |
|||
} |
|||
}, |
|||
}, |
|||
}, |
|||
} |
|||
}, |
|||
"/cookie_examples/": { |
|||
"get": { |
|||
"summary": "Cookie Examples", |
|||
"operationId": "cookie_examples_cookie_examples__get", |
|||
"parameters": [ |
|||
{ |
|||
"name": "data", |
|||
"in": "cookie", |
|||
"required": False, |
|||
"schema": IsDict( |
|||
{ |
|||
"anyOf": [{"type": "string"}, {"type": "null"}], |
|||
"examples": [ |
|||
"json_schema_cookie1", |
|||
"json_schema_cookie2", |
|||
], |
|||
"title": "Data", |
|||
} |
|||
) |
|||
| IsDict( |
|||
# TODO: remove when deprecating Pydantic v1 |
|||
{ |
|||
"type": "string", |
|||
"examples": [ |
|||
"json_schema_cookie1", |
|||
"json_schema_cookie2", |
|||
], |
|||
"title": "Data", |
|||
} |
|||
), |
|||
"examples": { |
|||
"Cookie One": { |
|||
"summary": "Cookie One Summary", |
|||
"description": "Cookie One Description", |
|||
"value": "cookie1", |
|||
}, |
|||
"Cookie Two": {"value": "cookie2"}, |
|||
}, |
|||
} |
|||
], |
|||
"responses": { |
|||
"200": { |
|||
"description": "Successful Response", |
|||
"content": {"application/json": {"schema": {}}}, |
|||
}, |
|||
"422": { |
|||
"description": "Validation Error", |
|||
"content": { |
|||
"application/json": { |
|||
"schema": { |
|||
"$ref": "#/components/schemas/HTTPValidationError" |
|||
} |
|||
} |
|||
}, |
|||
}, |
|||
}, |
|||
} |
|||
}, |
|||
}, |
|||
"components": { |
|||
"schemas": { |
|||
"HTTPValidationError": { |
|||
"properties": { |
|||
"detail": { |
|||
"items": {"$ref": "#/components/schemas/ValidationError"}, |
|||
"type": "array", |
|||
"title": "Detail", |
|||
} |
|||
}, |
|||
"type": "object", |
|||
"title": "HTTPValidationError", |
|||
}, |
|||
"Item": { |
|||
"properties": {"data": {"type": "string", "title": "Data"}}, |
|||
"type": "object", |
|||
"required": ["data"], |
|||
"title": "Item", |
|||
}, |
|||
"ValidationError": { |
|||
"properties": { |
|||
"loc": { |
|||
"items": { |
|||
"anyOf": [{"type": "string"}, {"type": "integer"}] |
|||
}, |
|||
"type": "array", |
|||
"title": "Location", |
|||
}, |
|||
"msg": {"type": "string", "title": "Message"}, |
|||
"type": {"type": "string", "title": "Error Type"}, |
|||
}, |
|||
"type": "object", |
|||
"required": ["loc", "msg", "type"], |
|||
"title": "ValidationError", |
|||
}, |
|||
} |
|||
}, |
|||
} |
|||
@ -0,0 +1,166 @@ |
|||
import pytest |
|||
from dirty_equals import IsDict |
|||
from fastapi.testclient import TestClient |
|||
|
|||
|
|||
@pytest.fixture(name="client") |
|||
def get_client(): |
|||
from docs_src.schema_extra_example.tutorial005 import app |
|||
|
|||
client = TestClient(app) |
|||
return client |
|||
|
|||
|
|||
def test_post_body_example(client: TestClient): |
|||
response = client.put( |
|||
"/items/5", |
|||
json={ |
|||
"name": "Foo", |
|||
"description": "A very nice Item", |
|||
"price": 35.4, |
|||
"tax": 3.2, |
|||
}, |
|||
) |
|||
assert response.status_code == 200 |
|||
|
|||
|
|||
def test_openapi_schema(client: TestClient) -> None: |
|||
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": { |
|||
"/items/{item_id}": { |
|||
"put": { |
|||
"summary": "Update Item", |
|||
"operationId": "update_item_items__item_id__put", |
|||
"parameters": [ |
|||
{ |
|||
"required": True, |
|||
"schema": {"title": "Item Id", "type": "integer"}, |
|||
"name": "item_id", |
|||
"in": "path", |
|||
} |
|||
], |
|||
"requestBody": { |
|||
"content": { |
|||
"application/json": { |
|||
"schema": IsDict({"$ref": "#/components/schemas/Item"}) |
|||
| IsDict( |
|||
# TODO: remove when deprecating Pydantic v1 |
|||
{ |
|||
"allOf": [ |
|||
{"$ref": "#/components/schemas/Item"} |
|||
], |
|||
"title": "Item", |
|||
} |
|||
), |
|||
"examples": { |
|||
"normal": { |
|||
"summary": "A normal example", |
|||
"description": "A **normal** item works correctly.", |
|||
"value": { |
|||
"name": "Foo", |
|||
"description": "A very nice Item", |
|||
"price": 35.4, |
|||
"tax": 3.2, |
|||
}, |
|||
}, |
|||
"converted": { |
|||
"summary": "An example with converted data", |
|||
"description": "FastAPI can convert price `strings` to actual `numbers` automatically", |
|||
"value": {"name": "Bar", "price": "35.4"}, |
|||
}, |
|||
"invalid": { |
|||
"summary": "Invalid data is rejected with an error", |
|||
"value": { |
|||
"name": "Baz", |
|||
"price": "thirty five point four", |
|||
}, |
|||
}, |
|||
}, |
|||
} |
|||
}, |
|||
"required": True, |
|||
}, |
|||
"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"}, |
|||
} |
|||
}, |
|||
}, |
|||
"Item": { |
|||
"title": "Item", |
|||
"required": ["name", "price"], |
|||
"type": "object", |
|||
"properties": { |
|||
"name": {"title": "Name", "type": "string"}, |
|||
"description": IsDict( |
|||
{ |
|||
"title": "Description", |
|||
"anyOf": [{"type": "string"}, {"type": "null"}], |
|||
} |
|||
) |
|||
| IsDict( |
|||
# TODO: remove when deprecating Pydantic v1 |
|||
{"title": "Description", "type": "string"} |
|||
), |
|||
"price": {"title": "Price", "type": "number"}, |
|||
"tax": IsDict( |
|||
{ |
|||
"title": "Tax", |
|||
"anyOf": [{"type": "number"}, {"type": "null"}], |
|||
} |
|||
) |
|||
| IsDict( |
|||
# TODO: remove when deprecating Pydantic v1 |
|||
{"title": "Tax", "type": "number"} |
|||
), |
|||
}, |
|||
}, |
|||
"ValidationError": { |
|||
"title": "ValidationError", |
|||
"required": ["loc", "msg", "type"], |
|||
"type": "object", |
|||
"properties": { |
|||
"loc": { |
|||
"title": "Location", |
|||
"type": "array", |
|||
"items": { |
|||
"anyOf": [{"type": "string"}, {"type": "integer"}] |
|||
}, |
|||
}, |
|||
"msg": {"title": "Message", "type": "string"}, |
|||
"type": {"title": "Error Type", "type": "string"}, |
|||
}, |
|||
}, |
|||
} |
|||
}, |
|||
} |
|||
@ -0,0 +1,166 @@ |
|||
import pytest |
|||
from dirty_equals import IsDict |
|||
from fastapi.testclient import TestClient |
|||
|
|||
|
|||
@pytest.fixture(name="client") |
|||
def get_client(): |
|||
from docs_src.schema_extra_example.tutorial005_an import app |
|||
|
|||
client = TestClient(app) |
|||
return client |
|||
|
|||
|
|||
def test_post_body_example(client: TestClient): |
|||
response = client.put( |
|||
"/items/5", |
|||
json={ |
|||
"name": "Foo", |
|||
"description": "A very nice Item", |
|||
"price": 35.4, |
|||
"tax": 3.2, |
|||
}, |
|||
) |
|||
assert response.status_code == 200 |
|||
|
|||
|
|||
def test_openapi_schema(client: TestClient) -> None: |
|||
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": { |
|||
"/items/{item_id}": { |
|||
"put": { |
|||
"summary": "Update Item", |
|||
"operationId": "update_item_items__item_id__put", |
|||
"parameters": [ |
|||
{ |
|||
"required": True, |
|||
"schema": {"title": "Item Id", "type": "integer"}, |
|||
"name": "item_id", |
|||
"in": "path", |
|||
} |
|||
], |
|||
"requestBody": { |
|||
"content": { |
|||
"application/json": { |
|||
"schema": IsDict({"$ref": "#/components/schemas/Item"}) |
|||
| IsDict( |
|||
# TODO: remove when deprecating Pydantic v1 |
|||
{ |
|||
"allOf": [ |
|||
{"$ref": "#/components/schemas/Item"} |
|||
], |
|||
"title": "Item", |
|||
} |
|||
), |
|||
"examples": { |
|||
"normal": { |
|||
"summary": "A normal example", |
|||
"description": "A **normal** item works correctly.", |
|||
"value": { |
|||
"name": "Foo", |
|||
"description": "A very nice Item", |
|||
"price": 35.4, |
|||
"tax": 3.2, |
|||
}, |
|||
}, |
|||
"converted": { |
|||
"summary": "An example with converted data", |
|||
"description": "FastAPI can convert price `strings` to actual `numbers` automatically", |
|||
"value": {"name": "Bar", "price": "35.4"}, |
|||
}, |
|||
"invalid": { |
|||
"summary": "Invalid data is rejected with an error", |
|||
"value": { |
|||
"name": "Baz", |
|||
"price": "thirty five point four", |
|||
}, |
|||
}, |
|||
}, |
|||
} |
|||
}, |
|||
"required": True, |
|||
}, |
|||
"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"}, |
|||
} |
|||
}, |
|||
}, |
|||
"Item": { |
|||
"title": "Item", |
|||
"required": ["name", "price"], |
|||
"type": "object", |
|||
"properties": { |
|||
"name": {"title": "Name", "type": "string"}, |
|||
"description": IsDict( |
|||
{ |
|||
"title": "Description", |
|||
"anyOf": [{"type": "string"}, {"type": "null"}], |
|||
} |
|||
) |
|||
| IsDict( |
|||
# TODO: remove when deprecating Pydantic v1 |
|||
{"title": "Description", "type": "string"} |
|||
), |
|||
"price": {"title": "Price", "type": "number"}, |
|||
"tax": IsDict( |
|||
{ |
|||
"title": "Tax", |
|||
"anyOf": [{"type": "number"}, {"type": "null"}], |
|||
} |
|||
) |
|||
| IsDict( |
|||
# TODO: remove when deprecating Pydantic v1 |
|||
{"title": "Tax", "type": "number"} |
|||
), |
|||
}, |
|||
}, |
|||
"ValidationError": { |
|||
"title": "ValidationError", |
|||
"required": ["loc", "msg", "type"], |
|||
"type": "object", |
|||
"properties": { |
|||
"loc": { |
|||
"title": "Location", |
|||
"type": "array", |
|||
"items": { |
|||
"anyOf": [{"type": "string"}, {"type": "integer"}] |
|||
}, |
|||
}, |
|||
"msg": {"title": "Message", "type": "string"}, |
|||
"type": {"title": "Error Type", "type": "string"}, |
|||
}, |
|||
}, |
|||
} |
|||
}, |
|||
} |
|||
@ -0,0 +1,170 @@ |
|||
import pytest |
|||
from dirty_equals import IsDict |
|||
from fastapi.testclient import TestClient |
|||
|
|||
from ...utils import needs_py310 |
|||
|
|||
|
|||
@pytest.fixture(name="client") |
|||
def get_client(): |
|||
from docs_src.schema_extra_example.tutorial005_an_py310 import app |
|||
|
|||
client = TestClient(app) |
|||
return client |
|||
|
|||
|
|||
@needs_py310 |
|||
def test_post_body_example(client: TestClient): |
|||
response = client.put( |
|||
"/items/5", |
|||
json={ |
|||
"name": "Foo", |
|||
"description": "A very nice Item", |
|||
"price": 35.4, |
|||
"tax": 3.2, |
|||
}, |
|||
) |
|||
assert response.status_code == 200 |
|||
|
|||
|
|||
@needs_py310 |
|||
def test_openapi_schema(client: TestClient) -> None: |
|||
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": { |
|||
"/items/{item_id}": { |
|||
"put": { |
|||
"summary": "Update Item", |
|||
"operationId": "update_item_items__item_id__put", |
|||
"parameters": [ |
|||
{ |
|||
"required": True, |
|||
"schema": {"title": "Item Id", "type": "integer"}, |
|||
"name": "item_id", |
|||
"in": "path", |
|||
} |
|||
], |
|||
"requestBody": { |
|||
"content": { |
|||
"application/json": { |
|||
"schema": IsDict({"$ref": "#/components/schemas/Item"}) |
|||
| IsDict( |
|||
# TODO: remove when deprecating Pydantic v1 |
|||
{ |
|||
"allOf": [ |
|||
{"$ref": "#/components/schemas/Item"} |
|||
], |
|||
"title": "Item", |
|||
} |
|||
), |
|||
"examples": { |
|||
"normal": { |
|||
"summary": "A normal example", |
|||
"description": "A **normal** item works correctly.", |
|||
"value": { |
|||
"name": "Foo", |
|||
"description": "A very nice Item", |
|||
"price": 35.4, |
|||
"tax": 3.2, |
|||
}, |
|||
}, |
|||
"converted": { |
|||
"summary": "An example with converted data", |
|||
"description": "FastAPI can convert price `strings` to actual `numbers` automatically", |
|||
"value": {"name": "Bar", "price": "35.4"}, |
|||
}, |
|||
"invalid": { |
|||
"summary": "Invalid data is rejected with an error", |
|||
"value": { |
|||
"name": "Baz", |
|||
"price": "thirty five point four", |
|||
}, |
|||
}, |
|||
}, |
|||
} |
|||
}, |
|||
"required": True, |
|||
}, |
|||
"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"}, |
|||
} |
|||
}, |
|||
}, |
|||
"Item": { |
|||
"title": "Item", |
|||
"required": ["name", "price"], |
|||
"type": "object", |
|||
"properties": { |
|||
"name": {"title": "Name", "type": "string"}, |
|||
"description": IsDict( |
|||
{ |
|||
"title": "Description", |
|||
"anyOf": [{"type": "string"}, {"type": "null"}], |
|||
} |
|||
) |
|||
| IsDict( |
|||
# TODO: remove when deprecating Pydantic v1 |
|||
{"title": "Description", "type": "string"} |
|||
), |
|||
"price": {"title": "Price", "type": "number"}, |
|||
"tax": IsDict( |
|||
{ |
|||
"title": "Tax", |
|||
"anyOf": [{"type": "number"}, {"type": "null"}], |
|||
} |
|||
) |
|||
| IsDict( |
|||
# TODO: remove when deprecating Pydantic v1 |
|||
{"title": "Tax", "type": "number"} |
|||
), |
|||
}, |
|||
}, |
|||
"ValidationError": { |
|||
"title": "ValidationError", |
|||
"required": ["loc", "msg", "type"], |
|||
"type": "object", |
|||
"properties": { |
|||
"loc": { |
|||
"title": "Location", |
|||
"type": "array", |
|||
"items": { |
|||
"anyOf": [{"type": "string"}, {"type": "integer"}] |
|||
}, |
|||
}, |
|||
"msg": {"title": "Message", "type": "string"}, |
|||
"type": {"title": "Error Type", "type": "string"}, |
|||
}, |
|||
}, |
|||
} |
|||
}, |
|||
} |
|||
@ -0,0 +1,170 @@ |
|||
import pytest |
|||
from dirty_equals import IsDict |
|||
from fastapi.testclient import TestClient |
|||
|
|||
from ...utils import needs_py39 |
|||
|
|||
|
|||
@pytest.fixture(name="client") |
|||
def get_client(): |
|||
from docs_src.schema_extra_example.tutorial005_an_py39 import app |
|||
|
|||
client = TestClient(app) |
|||
return client |
|||
|
|||
|
|||
@needs_py39 |
|||
def test_post_body_example(client: TestClient): |
|||
response = client.put( |
|||
"/items/5", |
|||
json={ |
|||
"name": "Foo", |
|||
"description": "A very nice Item", |
|||
"price": 35.4, |
|||
"tax": 3.2, |
|||
}, |
|||
) |
|||
assert response.status_code == 200 |
|||
|
|||
|
|||
@needs_py39 |
|||
def test_openapi_schema(client: TestClient) -> None: |
|||
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": { |
|||
"/items/{item_id}": { |
|||
"put": { |
|||
"summary": "Update Item", |
|||
"operationId": "update_item_items__item_id__put", |
|||
"parameters": [ |
|||
{ |
|||
"required": True, |
|||
"schema": {"title": "Item Id", "type": "integer"}, |
|||
"name": "item_id", |
|||
"in": "path", |
|||
} |
|||
], |
|||
"requestBody": { |
|||
"content": { |
|||
"application/json": { |
|||
"schema": IsDict({"$ref": "#/components/schemas/Item"}) |
|||
| IsDict( |
|||
# TODO: remove when deprecating Pydantic v1 |
|||
{ |
|||
"allOf": [ |
|||
{"$ref": "#/components/schemas/Item"} |
|||
], |
|||
"title": "Item", |
|||
} |
|||
), |
|||
"examples": { |
|||
"normal": { |
|||
"summary": "A normal example", |
|||
"description": "A **normal** item works correctly.", |
|||
"value": { |
|||
"name": "Foo", |
|||
"description": "A very nice Item", |
|||
"price": 35.4, |
|||
"tax": 3.2, |
|||
}, |
|||
}, |
|||
"converted": { |
|||
"summary": "An example with converted data", |
|||
"description": "FastAPI can convert price `strings` to actual `numbers` automatically", |
|||
"value": {"name": "Bar", "price": "35.4"}, |
|||
}, |
|||
"invalid": { |
|||
"summary": "Invalid data is rejected with an error", |
|||
"value": { |
|||
"name": "Baz", |
|||
"price": "thirty five point four", |
|||
}, |
|||
}, |
|||
}, |
|||
} |
|||
}, |
|||
"required": True, |
|||
}, |
|||
"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"}, |
|||
} |
|||
}, |
|||
}, |
|||
"Item": { |
|||
"title": "Item", |
|||
"required": ["name", "price"], |
|||
"type": "object", |
|||
"properties": { |
|||
"name": {"title": "Name", "type": "string"}, |
|||
"description": IsDict( |
|||
{ |
|||
"title": "Description", |
|||
"anyOf": [{"type": "string"}, {"type": "null"}], |
|||
} |
|||
) |
|||
| IsDict( |
|||
# TODO: remove when deprecating Pydantic v1 |
|||
{"title": "Description", "type": "string"} |
|||
), |
|||
"price": {"title": "Price", "type": "number"}, |
|||
"tax": IsDict( |
|||
{ |
|||
"title": "Tax", |
|||
"anyOf": [{"type": "number"}, {"type": "null"}], |
|||
} |
|||
) |
|||
| IsDict( |
|||
# TODO: remove when deprecating Pydantic v1 |
|||
{"title": "Tax", "type": "number"} |
|||
), |
|||
}, |
|||
}, |
|||
"ValidationError": { |
|||
"title": "ValidationError", |
|||
"required": ["loc", "msg", "type"], |
|||
"type": "object", |
|||
"properties": { |
|||
"loc": { |
|||
"title": "Location", |
|||
"type": "array", |
|||
"items": { |
|||
"anyOf": [{"type": "string"}, {"type": "integer"}] |
|||
}, |
|||
}, |
|||
"msg": {"title": "Message", "type": "string"}, |
|||
"type": {"title": "Error Type", "type": "string"}, |
|||
}, |
|||
}, |
|||
} |
|||
}, |
|||
} |
|||
@ -0,0 +1,170 @@ |
|||
import pytest |
|||
from dirty_equals import IsDict |
|||
from fastapi.testclient import TestClient |
|||
|
|||
from ...utils import needs_py310 |
|||
|
|||
|
|||
@pytest.fixture(name="client") |
|||
def get_client(): |
|||
from docs_src.schema_extra_example.tutorial005_py310 import app |
|||
|
|||
client = TestClient(app) |
|||
return client |
|||
|
|||
|
|||
@needs_py310 |
|||
def test_post_body_example(client: TestClient): |
|||
response = client.put( |
|||
"/items/5", |
|||
json={ |
|||
"name": "Foo", |
|||
"description": "A very nice Item", |
|||
"price": 35.4, |
|||
"tax": 3.2, |
|||
}, |
|||
) |
|||
assert response.status_code == 200 |
|||
|
|||
|
|||
@needs_py310 |
|||
def test_openapi_schema(client: TestClient) -> None: |
|||
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": { |
|||
"/items/{item_id}": { |
|||
"put": { |
|||
"summary": "Update Item", |
|||
"operationId": "update_item_items__item_id__put", |
|||
"parameters": [ |
|||
{ |
|||
"required": True, |
|||
"schema": {"title": "Item Id", "type": "integer"}, |
|||
"name": "item_id", |
|||
"in": "path", |
|||
} |
|||
], |
|||
"requestBody": { |
|||
"content": { |
|||
"application/json": { |
|||
"schema": IsDict({"$ref": "#/components/schemas/Item"}) |
|||
| IsDict( |
|||
# TODO: remove when deprecating Pydantic v1 |
|||
{ |
|||
"allOf": [ |
|||
{"$ref": "#/components/schemas/Item"} |
|||
], |
|||
"title": "Item", |
|||
} |
|||
), |
|||
"examples": { |
|||
"normal": { |
|||
"summary": "A normal example", |
|||
"description": "A **normal** item works correctly.", |
|||
"value": { |
|||
"name": "Foo", |
|||
"description": "A very nice Item", |
|||
"price": 35.4, |
|||
"tax": 3.2, |
|||
}, |
|||
}, |
|||
"converted": { |
|||
"summary": "An example with converted data", |
|||
"description": "FastAPI can convert price `strings` to actual `numbers` automatically", |
|||
"value": {"name": "Bar", "price": "35.4"}, |
|||
}, |
|||
"invalid": { |
|||
"summary": "Invalid data is rejected with an error", |
|||
"value": { |
|||
"name": "Baz", |
|||
"price": "thirty five point four", |
|||
}, |
|||
}, |
|||
}, |
|||
} |
|||
}, |
|||
"required": True, |
|||
}, |
|||
"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"}, |
|||
} |
|||
}, |
|||
}, |
|||
"Item": { |
|||
"title": "Item", |
|||
"required": ["name", "price"], |
|||
"type": "object", |
|||
"properties": { |
|||
"name": {"title": "Name", "type": "string"}, |
|||
"description": IsDict( |
|||
{ |
|||
"title": "Description", |
|||
"anyOf": [{"type": "string"}, {"type": "null"}], |
|||
} |
|||
) |
|||
| IsDict( |
|||
# TODO: remove when deprecating Pydantic v1 |
|||
{"title": "Description", "type": "string"} |
|||
), |
|||
"price": {"title": "Price", "type": "number"}, |
|||
"tax": IsDict( |
|||
{ |
|||
"title": "Tax", |
|||
"anyOf": [{"type": "number"}, {"type": "null"}], |
|||
} |
|||
) |
|||
| IsDict( |
|||
# TODO: remove when deprecating Pydantic v1 |
|||
{"title": "Tax", "type": "number"} |
|||
), |
|||
}, |
|||
}, |
|||
"ValidationError": { |
|||
"title": "ValidationError", |
|||
"required": ["loc", "msg", "type"], |
|||
"type": "object", |
|||
"properties": { |
|||
"loc": { |
|||
"title": "Location", |
|||
"type": "array", |
|||
"items": { |
|||
"anyOf": [{"type": "string"}, {"type": "integer"}] |
|||
}, |
|||
}, |
|||
"msg": {"title": "Message", "type": "string"}, |
|||
"type": {"title": "Error Type", "type": "string"}, |
|||
}, |
|||
}, |
|||
} |
|||
}, |
|||
} |
|||
Loading…
Reference in new issue