隐藏Django休息框架路由器Api查看页面

Question

我在django应用程序中使用DjangoRestFramework 3.3.2进行路由。我有6个应用程序和1个主要项目应用程序的6个不同文件夹。我已将所有6个应用网址都包含在主网址文件中。以下是我的主要网址文件。

from django.conf.urls import include, url
from django.contrib import admin

urlpatterns = [
    url(r'^admin/', admin.site.urls),
    url(r'^vpc/', include('vpc.urls')),
    url(r'^dss/', include('dss.urls')),
    url(r'^rds/', include('rds.urls')),
    url(r'^compute/', include('compute.urls')),
    url(r'^iam/', include('iam.urls')),
]

这是我的app url文件之一。

from django.conf.urls import url
from rest_framework import routers
import views.instance_views as instance
import views.snapshot_views as snapshot

router = routers.SimpleRouter()
router.register(r'instance', instance.IntanceViewSet, base_name='instance')
router.register(r'snapshot', snapshot.SnapshotViewSet, base_name='snapshot')

urlpatterns = []

urlpatterns += router.urls

现在我的问题是当我在浏览器中打开网址时，我可以看到整个网址层次结构。这不是必需的。

如何隐藏这些渲染的视图。我不想显示任何额外信息

我可以使用以下方式隐藏视图：

REST_FRAMEWORK = {
    'DEFAULT_RENDERER_CLASSES': (
        'rest_framework.renderers.JSONRenderer',
    )
}

但我仍然在1 app以下获得所有网址。

{"instance":"http://127.0.0.1:8000/compute/instance/","keypair":"http://127.0.0.1:8000/compute/keypair/","volume":"http://127.0.0.1:8000/compute/volume/","image":"http://127.0.0.1:8000/compute/image/","snapshot":"http://127.0.0.1:8000/compute/snapshot/"}

Answer 1

在您的urls.py中将默认路由器更改为简单路由器。

router = routers.SimpleRouter()

您还应该在生产设置文件中添加以下代码段，以便仅为API启用JSONRenderer，这将完全禁用Web浏览API。

REST_FRAMEWORK = {
    'DEFAULT_RENDERER_CLASSES': (
        'rest_framework.renderers.JSONRenderer',
    )
}

Answer 2

在settings.py TRC_DP(fmt, args...)中，您的REST API不会显示。

Answer 3

只是为了更新给出的答案。您确实需要指定 SimpleRouter() 路由器，但通常 DefaultRouter() 路由器可用于在开发过程中查看和调试。

考虑到这一点，我建议您执行以下简单步骤：

if settings.DEBUG:
    router = DefaultRouter()
else:
    router = SimpleRouter()

然后像往常一样：

from myproject.users.api.viewsets import UserViewSet

router.register(r'users', UserViewSet)