encode/django-rest-framework
1
1
Fork 0
mirror of https://github.com/encode/django-rest-framework.git synced 2025-08-01 19:10:12 +03:00
Code Issues Packages Projects Releases Wiki Activity

feature(Secure API docs): added new flag to switch on/off the authentication needed to view the documentation of the APIs

Browse Source
This commit is contained in:
Luvpreet Singh 2019-02-05 19:18:31 +05:30
parent 7c6e34c14f
commit 3799a8b23a
2 changed files with 14 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
rest_framework/documentation.py
View File

@ -1,4 +1,5 @@
from django.conf.urls import include, url from django.conf.urls import include, url
from django.contrib.auth.decorators import login_required
from rest_framework.renderers import ( from rest_framework.renderers import (
CoreJSONRenderer, DocumentationRenderer, SchemaJSRenderer CoreJSONRenderer, DocumentationRenderer, SchemaJSRenderer
@ -77,8 +78,14 @@ def include_docs_urls(
authentication_classes=authentication_classes, authentication_classes=authentication_classes,
permission_classes=permission_classes, permission_classes=permission_classes,
) )
if api_settings.SECURE_DOCS is False:
urls = [ urls = [
url(r'^$', docs_view, name='docs-index'), url(r'^$', docs_view, name='docs-index'),
url(r'^schema.js$', schema_js_view, name='schema-js') url(r'^schema.js$', schema_js_view, name='schema-js')
] ]
else:
urls = [
url(r'^$', login_required(docs_view), name='docs-index'),
url(r'^schema.js$', login_required(schema_js_view), name='schema-js')
]
return include((urls, 'api-docs'), namespace='api-docs') return include((urls, 'api-docs'), namespace='api-docs')

3
rest_framework/settings.py
View File

@ -128,6 +128,9 @@ DEFAULTS = {
'retrieve': 'read', 'retrieve': 'read',
'destroy': 'delete' 'destroy': 'delete'
}, },
# Documentation
'SECURE_DOCS': False
} }