File tree Expand file tree Collapse file tree 3 files changed +31
-0
lines changed Expand file tree Collapse file tree 3 files changed +31
-0
lines changed Original file line number Diff line number Diff line change @@ -38,6 +38,12 @@ Finally include the `rest_framework_docs` urls in your `urls.py`:
3838 url(r'^docs/', include('rest_framework_docs.urls')),
3939 ]
4040
41+ ### Settings
42+
43+ REST_FRAMEWORK_DOCS = {
44+ 'HIDDEN': True # Default: False
45+ }
46+
4147### Roadmap
4248
4349 - [ ] Support Python 2 & Python 3
Original file line number Diff line number Diff line change 1+ from django .conf import settings
2+
3+
4+ class DRFSettings (object ):
5+
6+ def __init__ (self ):
7+ self .drf_settings = {
8+ "HIDDEN" : self .get_setting ("HIDDEN" ) or False
9+ }
10+
11+ def get_setting (self , name ):
12+ try :
13+ return settings .REST_FRAMEWORK_DOCS [name ]
14+ except :
15+ return None
16+
17+ @property
18+ def settings (self ):
19+ return self .drf_settings
Original file line number Diff line number Diff line change 1+ from django .http import Http404
12from django .views .generic .base import TemplateView
23from rest_framework_docs .api_docs import ApiDocumentation
4+ from rest_framework_docs .settings import DRFSettings
35
46
57class DRFDocsView (TemplateView ):
68
79 template_name = "rest_framework_docs/home.html"
810
911 def get_context_data (self , ** kwargs ):
12+ settings = DRFSettings ().settings
13+ if settings ["HIDDEN" ]:
14+ raise Http404 ("Django Rest Framework Docs are hidden. Check you settings." )
15+
1016 context = super (DRFDocsView , self ).get_context_data (** kwargs )
1117 docs = ApiDocumentation ()
1218 context ['endpoints' ] = docs .get_endpoints ()
You can’t perform that action at this time.
0 commit comments