Dokumentace API v DRF: Swagger a Redoc

Ukážeme si, jak generovat přehlednou dokumentaci API pomocí balíčků drf-yasg a drf-spectacular. Vysvětlíme, proč je dokumentace důležitá.

Dokumentace API v DRF: Swagger a Redoc

Dobrá dokumentace API šetří čas vývojářům i klientům. DRF nabízí integrace se Swagger a Redoc.

drf-yasg

pip install drf-yasg

V urls.py pak přidáme schema view a routy:

from drf_yasg.views import get_schema_view\nschema_view = get_schema_view(...)\nurlpatterns = [     path('swagger/', schema_view.with_ui('swagger')),     path('redoc/', schema_view.with_ui('redoc')), ]

drf-spectacular

Alternativa generující OpenAPI schema s větší flexibilitou.

Tímto uzavíráme blok DRF. Dalším tématem bude Django Ninja — moderní framework pro rychlou tvorbu API.

@admin

20. srpna 2025


Komentáře 0