mirror of
https://github.com/encode/django-rest-framework.git
synced 2025-01-24 16:24:18 +03:00
Add missing doc files
This commit is contained in:
parent
da4fa9bded
commit
40d1821f2d
9
docs/api-guide/authentication.md
Normal file
9
docs/api-guide/authentication.md
Normal file
|
@ -0,0 +1,9 @@
|
||||||
|
# Authentication
|
||||||
|
|
||||||
|
REST framework provides a number of authentication policies out of the box, and also allows you to implement custom policies.
|
||||||
|
|
||||||
|
## BasicAuthentication
|
||||||
|
|
||||||
|
## TokenBasicAuthentication
|
||||||
|
|
||||||
|
## SessionAuthentication
|
1
docs/api-guide/permissions.md
Normal file
1
docs/api-guide/permissions.md
Normal file
|
@ -0,0 +1 @@
|
||||||
|
|
31
docs/api-guide/settings.md
Normal file
31
docs/api-guide/settings.md
Normal file
|
@ -0,0 +1,31 @@
|
||||||
|
# Settings
|
||||||
|
|
||||||
|
Settings for REST framework are all namespaced in the `API_SETTINGS` setting.
|
||||||
|
For example your project's `settings.py` file might look like this:
|
||||||
|
|
||||||
|
API_SETTINGS = {
|
||||||
|
'DEFAULT_RENDERERS': (
|
||||||
|
'djangorestframework.renderers.JSONRenderer',
|
||||||
|
'djangorestframework.renderers.YAMLRenderer',
|
||||||
|
)
|
||||||
|
'DEFAULT_PARSERS': (
|
||||||
|
'djangorestframework.parsers.JSONParser',
|
||||||
|
'djangorestframework.parsers.YAMLParser',
|
||||||
|
)
|
||||||
|
}
|
||||||
|
|
||||||
|
## DEFAULT_RENDERERS
|
||||||
|
|
||||||
|
A list or tuple of renderer classes.
|
||||||
|
|
||||||
|
Default:
|
||||||
|
|
||||||
|
(
|
||||||
|
'djangorestframework.renderers.JSONRenderer',
|
||||||
|
'djangorestframework.renderers.DocumentingHTMLRenderer')`
|
||||||
|
|
||||||
|
## DEFAULT_PARSERS
|
||||||
|
|
||||||
|
A list or tuple of parser classes.
|
||||||
|
|
||||||
|
Default: `()`
|
1
docs/api-guide/throttling.md
Normal file
1
docs/api-guide/throttling.md
Normal file
|
@ -0,0 +1 @@
|
||||||
|
|
|
@ -79,9 +79,11 @@ The API guide is your complete reference manual to all the functionality provide
|
||||||
* [Serializers][serializers]
|
* [Serializers][serializers]
|
||||||
* [Authentication][authentication]
|
* [Authentication][authentication]
|
||||||
* [Permissions][permissions]
|
* [Permissions][permissions]
|
||||||
|
* [Throttling][throttling]
|
||||||
* [Exceptions][exceptions]
|
* [Exceptions][exceptions]
|
||||||
* [Status codes][status]
|
* [Status codes][status]
|
||||||
* [Returning URLs][urls]
|
* [Returning URLs][reverse]
|
||||||
|
* [Settings][settings]
|
||||||
|
|
||||||
## Topics
|
## Topics
|
||||||
|
|
||||||
|
@ -147,9 +149,11 @@ OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
||||||
[serializers]: api-guide/serializers.md
|
[serializers]: api-guide/serializers.md
|
||||||
[authentication]: api-guide/authentication.md
|
[authentication]: api-guide/authentication.md
|
||||||
[permissions]: api-guide/permissions.md
|
[permissions]: api-guide/permissions.md
|
||||||
|
[throttling]: api-guide/throttling.md
|
||||||
[exceptions]: api-guide/exceptions.md
|
[exceptions]: api-guide/exceptions.md
|
||||||
[status]: api-guide/status.md
|
[status]: api-guide/status.md
|
||||||
[urls]: api-guide/urls.md
|
[reverse]: api-guide/reverse.md
|
||||||
|
[settings]: api-guide/settings.md
|
||||||
|
|
||||||
[csrf]: topics/csrf.md
|
[csrf]: topics/csrf.md
|
||||||
[formoverloading]: topics/formoverloading.md
|
[formoverloading]: topics/formoverloading.md
|
||||||
|
|
|
@ -94,7 +94,8 @@ margin-top: 5px;
|
||||||
<li><a href="{{ base_url }}/api-guide/throttling{{ suffix }}">Throttling</a></li>
|
<li><a href="{{ base_url }}/api-guide/throttling{{ suffix }}">Throttling</a></li>
|
||||||
<li><a href="{{ base_url }}/api-guide/exceptions{{ suffix }}">Exceptions</a></li>
|
<li><a href="{{ base_url }}/api-guide/exceptions{{ suffix }}">Exceptions</a></li>
|
||||||
<li><a href="{{ base_url }}/api-guide/status-codes{{ suffix }}">Status codes</a></li>
|
<li><a href="{{ base_url }}/api-guide/status-codes{{ suffix }}">Status codes</a></li>
|
||||||
<li><a href="{{ base_url }}/api-guide/urls{{ suffix }}">Returning URLs</a></li>
|
<li><a href="{{ base_url }}/api-guide/reverse{{ suffix }}">Returning URLs</a></li>
|
||||||
|
<li><a href="{{ base_url }}/api-guide/settings{{ suffix }}">Settings</a></li>
|
||||||
</ul>
|
</ul>
|
||||||
</li>
|
</li>
|
||||||
<li class="dropdown">
|
<li class="dropdown">
|
||||||
|
|
Loading…
Reference in New Issue
Block a user