https://github.com/alexdemure/gadopenapi
Customize and override OpenAPI schema details in FastAPI with ease
https://github.com/alexdemure/gadopenapi
fastapi fastapi-extension openapi openapi-codegen
Last synced: 12 months ago
JSON representation
Customize and override OpenAPI schema details in FastAPI with ease
- Host: GitHub
- URL: https://github.com/alexdemure/gadopenapi
- Owner: AlexDemure
- License: mit
- Created: 2025-03-24T14:00:31.000Z (about 1 year ago)
- Default Branch: production
- Last Pushed: 2025-04-07T13:45:18.000Z (12 months ago)
- Last Synced: 2025-04-07T14:16:34.529Z (12 months ago)
- Topics: fastapi, fastapi-extension, openapi, openapi-codegen
- Language: Python
- Homepage:
- Size: 11.7 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
Utility toolkit to modify and override OpenAPI schema definitions in FastAPI.
---
## Installation
```
pip install gadopenapi
```
## Usage
```
from gadopenapi import OpenAPI
app.openapi = OpenAPI(app)
```
### Extension ```gadopenapi.extensions.affix```
```
from fastapi import FastAPI
from pydantic import BaseModel
from gadopenapi import OpenAPI
from gadopenapi.extensions.affix import affix
app = FastAPI()
app.openapi = OpenAPI(app, handlers=[affix])
class Deprecated(BaseModel):
__affix__ = "Deprecated:"
class User(Deprecated):
id: int
@app.get("/user", response_model=User)
def get_user():
return {"id": 1}
openapi.json
>>>
{
"paths": {
"schema": {
"$ref": "#/components/schemas/DeprecatedUser"
}
},
"schemas": {
"DeprecatedUser": {
"title": "DeprecatedUser"
}
}
}
```
### Extension ```gadopenapi.extensions.operationid```
```
from fastapi import FastAPI
from pydantic import BaseModel
from gadopenapi import OpenAPI
from gadopenapi.extensions.operationid import use_route_as_operation_id
app = FastAPI()
app.openapi = OpenAPI(app, handlers=[use_route_as_operation_id])
class User(BaseModel):
id: int
@app.get("/user", response_model=User)
def get_user():
return {"id": 1}
openapi.json
>>> BEFORE
{
"paths": {
"/user": {
"get": {
"operationId": "get_user_user_get",
}
}
}
}
>>> AFTER
{
"paths": {
"/user": {
"get": {
"operationId": "get_user",
}
}
}
}
```
### Extension ```gadopenapi.extensions.errors```
```
from fastapi import FastAPI
from gadopenapi.extensions.errors import APIError, openapi_errors
app = FastAPI()
class MyError(APIError):
...
@app.get("/user", response_model=dict, responses=openapi_errors(MyError))
def get_user():
return {"id": 1}
openapi.json
>>>
{
"paths": {
"/user": {
"get": {
"responses": {
"200": {
"description": "Successful Response"
},
"418": {
"description": "MyError",
"content": {
"application/json": {
"example": {
"status_code": 418,
"detail": {
"type": "MyError"
}
}
}
}
}
}
}
}
}
}
```
### Custom handler
```
from fastapi import FastAPI
from gadopenapi import OpenAPI
def my_handler(app: FastAPI, openapi: dict) -> tuple[FastAPI, dict]:
# Mutate openapi here
return app, openapi
app = FastAPI()
app.openapi = OpenAPI(app, handlers=[my_handler])
@app.get("/user", response_model=dict)
def get_user():
return {"id": 1}
```
