如何禁用Django REST框架文档页面

时间:2019-07-01 20:01:23

标签: django django-rest-framework

我目前正在使用Django REST框架,它对我来说很好用。问题在于API文档页面在生产环境中是公开的,我希望只能在开发(localhost)或管理员用户中看到它。

这是我的urls.py

schema_view = get_schema_view(title='My API')
router = DefaultRouter()
# router.register(...) 

urlpatterns = [
    url(r'', include(router.urls)),
    url(r'^docs/', include_docs_urls(title='My API service')),
    url(r'^schema/$', schema_view),
]


PS:我正在使用版本3.9.2

1 个答案:

答案 0 :(得分:0)

您始终可以检查DEBUG的值,并进行设置(如果在开发模式下将其设置为True)来进行处理。例如:

from django.conf import settings

urlpatterns = [
    url(r'', include(router.urls)),
    url(r'^schema/$', schema_view),
]

if settings.DEBUG:
    urlpatterns += [
        url(r'^docs/', include_docs_urls(title='My API service'))
    ]