您的位置:首页 > 科技 > 能源 > django 接口文档自动生成

django 接口文档自动生成

2024/11/18 11:22:43 来源:https://blog.csdn.net/weixin_53704902/article/details/140500390  浏览:    关键词:django 接口文档自动生成
  1. 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'), ... ]
    

版权声明:

本网仅为发布的内容提供存储空间,不对发表、转载的内容提供任何形式的保证。凡本网注明“来源:XXX网络”的作品,均转载自其它媒体,著作权归作者所有,商业转载请联系作者获得授权,非商业转载请注明出处。

我们尊重并感谢每一位作者,均已注明文章来源和作者。如因作品内容、版权或其它问题,请及时与我们联系,联系邮箱:809451989@qq.com,投稿邮箱:809451989@qq.com