django 接口文档自动生成

最新推荐文章于 2025-03-15 15:22:45 发布

E.K.江湖念书人

最新推荐文章于 2025-03-15 15:22:45 发布

阅读量753

点赞数 6

文章标签： django python 后端

本文链接：https://blog.csdn.net/weixin_53704902/article/details/140500390

版权

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'), ... ]