Параметр license_info
Параметр license_info передаётся в конструктор класса
FastAPI и принимает словарь с данными о лицензии.
Эта информация попадает в схему OpenAPI и отображается
в интерактивной документации Swagger UI и ReDoc.
Обычно словарь содержит ключи name и url,
где name - название лицензии, а url - ссылка
на её полный текст.
Синтаксис
app = FastAPI(license_info={'name': ..., 'url': ...})
Пример
Давайте создадим приложение с лицензией MIT:
from fastapi import FastAPI
app = FastAPI(
license_info={
'name': 'MIT License',
'url': 'https://opensource.org/licenses/MIT'
}
)
@app.get('/')
def index():
return {'text': 'hello'}
Теперь в документации /docs в разделе лицензии
появится ссылка с названием MIT License.
Пример
Давайте укажем лицензию Apache 2.0 и проверим её наличие в схеме OpenAPI:
from fastapi import FastAPI
app = FastAPI(
license_info={
'name': 'Apache 2.0',
'url': 'https://www.apache.org/licenses/LICENSE-2.0.html'
}
)
@app.get('/')
def index():
return {'text': 'hello'}
res = app.openapi()
print(res['info']['license'])
Результат выполнения кода:
{'name': 'Apache 2.0', 'url': 'https://www.apache.org/licenses/LICENSE-2.0.html'}
Пример
Параметр license_info можно указать только с названием,
без ссылки:
from fastapi import FastAPI
app = FastAPI(
license_info={'name': 'Proprietary'}
)
@app.get('/')
def index():
return {'text': 'hello'}
Результат выполнения кода:
{'name': 'Proprietary'}
Смотрите также
-
параметр
contact,
который задаёт контактные данные автора приложения -
параметр
summary,
который задаёт краткое описание приложения -
параметр
description,
который задаёт подробное описание приложения -
параметр
servers,
который задаёт список серверов для OpenAPI-схемы
