Users can add additional information with x-fields. But Python does not accept identifiers with dashses.
Here are some common vendor extensions documented: https://github.com/Redocly/redoc/blob/main/docs/redoc-vendor-extensions.md#x-logo
Here is example spec:
openapi: 3.0.0
info:
title: Example
version: 1.0.0
x-audience: company-internal
x-logo:
url: https://www.example.com/company-logo.pngThe generated code looks like this
app = FastAPI(
title='Example',
version='1.0.0',
x - audience='company-internal',
x - logo={'url': 'https://www.example.com/company-logo.png'},
)I fixed it this way:
--- fastapi_code_generator/template/main.jinja2.orig 2023-02-13 16:11:00.677867572 +0100
+++ fastapi_code_generator/template/main.jinja2 2023-02-13 16:37:28.944897684 +0100
@@ -8,7 +8,9 @@
{% if info %}
{% for key,value in info.items() %}
{% set info_value= value.__repr__() %}
+ {%- if not key.startswith("x-") -%}
{{ key }} = {{info_value}},
+ {%- endif -%}
{% endfor %}
{% endif %}
)First I tried to add all fields as a dict passed as kwargs:
app = FastAPI(**{
'title': 'Example',
'version': '1.0.0',
'x-audience': 'company-internal',
'x-logo': {'url': 'https://www.example.com/company-logo.png'},
})But ignoring these fields seems sufficient because FastAPI ignores them anyway.
koxudaxi / fastapi-code-generator
This code generator creates FastAPI app from an openapi file.
1.0k
How does funding with Polar work?
1
Pay now to fund the work behind this issue.
2
Get updates on progress being made.
3
Maintainer is rewarded once the issue is completed.
FAQ
Backer
You're funding impactful open source efforts
Contributor
You want to contribute to this effort
Maintainer
You want to get funding like this too