mirror of
https://github.com/encode/django-rest-framework.git
synced 2025-06-24 23:43:18 +03:00
Add documentation for the get_schema_view
new argument: patterns
This commit is contained in:
parent
d757127e9a
commit
36e5759498
|
@ -170,6 +170,22 @@ May be used to pass the set of renderer classes that can be used to render the A
|
||||||
renderer_classes=[CoreJSONRenderer, APIBlueprintRenderer]
|
renderer_classes=[CoreJSONRenderer, APIBlueprintRenderer]
|
||||||
)
|
)
|
||||||
|
|
||||||
|
#### `patterns`
|
||||||
|
|
||||||
|
List of url patterns to limit the schema introspection to. If you only want the `myproject.api` urls
|
||||||
|
to be exposed in the schema:
|
||||||
|
|
||||||
|
schema_url_patterns = [
|
||||||
|
url(r'^api/', include('myproject.api.urls')),
|
||||||
|
]
|
||||||
|
|
||||||
|
schema_view = get_schema_view(
|
||||||
|
title='Server Monitoring API',
|
||||||
|
url='https://www.example.org/api/',
|
||||||
|
patterns=schema_url_patterns,
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
## Using an explicit schema view
|
## Using an explicit schema view
|
||||||
|
|
||||||
If you need a little more control than the `get_schema_view()` shortcut gives you,
|
If you need a little more control than the `get_schema_view()` shortcut gives you,
|
||||||
|
|
Loading…
Reference in New Issue
Block a user