Skip to content

Commit 047bec1

Browse files
authored
Add documentation to show how to add authentication for the browseable api (#9137)
1 parent f4175b4 commit 047bec1

File tree

1 file changed

+12
-0
lines changed

1 file changed

+12
-0
lines changed

docs/topics/browsable-api.md

+12
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,18 @@ If you include fully-qualified URLs in your resource output, they will be 'urliz
1515

1616
By default, the API will return the format specified by the headers, which in the case of the browser is HTML. The format can be specified using `?format=` in the request, so you can look at the raw JSON response in a browser by adding `?format=json` to the URL. There are helpful extensions for viewing JSON in [Firefox][ffjsonview] and [Chrome][chromejsonview].
1717

18+
## Authentication
19+
20+
To quickly add authentication to the browesable api, add a routes named `"login"` and `"logout"` under the namespace `"rest_framework"`. DRF provides default routes for this which you can add to your urlconf:
21+
22+
```python
23+
urlpatterns = [
24+
// ...
25+
url(r'^api-auth/', include('rest_framework.urls', namespace='rest_framework'))
26+
]
27+
```
28+
29+
1830
## Customizing
1931

2032
The browsable API is built with [Twitter's Bootstrap][bootstrap] (v 3.4.1), making it easy to customize the look-and-feel.

0 commit comments

Comments
 (0)