Конфигурация

Всё опционально — djo работает из коробки с разумными значениями по умолчанию. Переопределить заголовок, версию, описание или сами пути документации можно через словарь DJO в settings.py:

DJO = {
    "TITLE": "My API",
    "VERSION": "1.0.0",
    "DESCRIPTION": "Internal API for the mobile app.",
    "DOCS_URL": "/docs",
    "OPENAPI_URL": "/openapi.json",
}

Ключ	По умолчанию	Описание
TITLE	"Django API"	Отображается в заголовке Swagger UI и в info.title.
VERSION	"1.0.0"	Строка версии рядом с заголовком, и info.version.
DESCRIPTION	(нет)	Markdown-описание в info.description. Полностью опускается, если не задано.
DOCS_URL	"/docs"	Путь, на котором отдаётся страница Swagger UI.
OPENAPI_URL	"/openapi.json"	Путь, на котором отдаётся сырая JSON-схема OpenAPI 3.0.

Кастомный путь документации

DJO = {"DOCS_URL": "/api/docs", "OPENAPI_URL": "/api/openapi.json"}

Middleware сравнивает точный путь запроса (без завершающего слэша) с этими двумя значениями до того, как передать запрос дальше по обычной цепочке резолюции URL — так что можно выбрать любой путь, не конфликтующий с существующими маршрутами.