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
100 lines
2.9 KiB
Python
100 lines
2.9 KiB
Python
import typing
|
|
|
|
from fastapi import FastAPI
|
|
from fastapi.responses import JSONResponse
|
|
from fastapi.testclient import TestClient
|
|
from pydantic import BaseModel
|
|
|
|
app = FastAPI()
|
|
|
|
|
|
class JsonApiResponse(JSONResponse):
|
|
media_type = "application/vnd.api+json"
|
|
|
|
|
|
class Error(BaseModel):
|
|
status: str
|
|
title: str
|
|
|
|
|
|
class JsonApiError(BaseModel):
|
|
errors: typing.List[Error]
|
|
|
|
|
|
@app.get(
|
|
"/a/{id}",
|
|
response_class=JsonApiResponse,
|
|
responses={422: {"description": "Error", "model": JsonApiError}},
|
|
)
|
|
async def a(id):
|
|
pass # pragma: no cover
|
|
|
|
|
|
client = TestClient(app)
|
|
|
|
|
|
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": {
|
|
"/a/{id}": {
|
|
"get": {
|
|
"responses": {
|
|
"422": {
|
|
"description": "Error",
|
|
"content": {
|
|
"application/vnd.api+json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/JsonApiError"
|
|
}
|
|
}
|
|
},
|
|
},
|
|
"200": {
|
|
"description": "Successful Response",
|
|
"content": {"application/vnd.api+json": {"schema": {}}},
|
|
},
|
|
},
|
|
"summary": "A",
|
|
"operationId": "a_a__id__get",
|
|
"parameters": [
|
|
{
|
|
"required": True,
|
|
"schema": {"title": "Id"},
|
|
"name": "id",
|
|
"in": "path",
|
|
}
|
|
],
|
|
}
|
|
}
|
|
},
|
|
"components": {
|
|
"schemas": {
|
|
"Error": {
|
|
"title": "Error",
|
|
"required": ["status", "title"],
|
|
"type": "object",
|
|
"properties": {
|
|
"status": {"title": "Status", "type": "string"},
|
|
"title": {"title": "Title", "type": "string"},
|
|
},
|
|
},
|
|
"JsonApiError": {
|
|
"title": "JsonApiError",
|
|
"required": ["errors"],
|
|
"type": "object",
|
|
"properties": {
|
|
"errors": {
|
|
"title": "Errors",
|
|
"type": "array",
|
|
"items": {"$ref": "#/components/schemas/Error"},
|
|
}
|
|
},
|
|
},
|
|
}
|
|
},
|
|
}
|