django 接口文档自动生成

Django REST Framework + drf-spectacular

drf-spectacular 是另一个用于DRF的工具,用于生成符合OpenAPI 3.0规范的API文档。它提供了更好的兼容性和定制性。

安装与配置

pip install djangorestframework drf-spectacular

settings.py中配置:

INSTALLED_APPS = [ ... 'rest_framework', 'drf_spectacular', ... ] 
REST_FRAMEWORK = { 'DEFAULT_SCHEMA_CLASS': 'drf_spectacular.openapi.AutoSchema', }

urls.py中添加路由:

from drf_spectacular.views import SpectacularAPIView, SpectacularSwaggerView urlpatterns = [ ... path('schema/', SpectacularAPIView.as_view(), name='schema'), path('schema/swagger-ui/', SpectacularSwaggerView.as_view(url_name='schema'), name='swagger-ui'), ... ]
上一篇:WHAT - Tailwind CSS 的灵活布局(Flex & Grid)-Grid 布局


下一篇:21天学通C++:第十三、十四章节-第十四章:宏和模板简介