You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+5-15
Original file line number
Diff line number
Diff line change
@@ -9,7 +9,9 @@ Full documentation for the project is available at [http://www.django-rest-frame
9
9
10
10
---
11
11
12
-
**Note**: We have now released Django REST framework 3.0. For older codebases you may want to refer to the version 2.4.4 [source code](https://github.com/tomchristie/django-rest-framework/tree/version-2.4.x), and [documentation](http://tomchristie.github.io/rest-framework-2-docs/).
12
+
**Note**: We have now released Django REST framework 3.1. For older codebases you may want to refer to the version 2.4.4 [source code](https://github.com/tomchristie/django-rest-framework/tree/version-2.4.x), and [documentation](http://tomchristie.github.io/rest-framework-2-docs/).
13
+
14
+
For more details see the [3.1 release notes][3.1-announcement]
13
15
14
16
---
15
17
@@ -23,7 +25,7 @@ Some reasons you might want to use REST framework:
23
25
*[Authentication policies][authentication] including optional packages for [OAuth1a][oauth1-section] and [OAuth2][oauth2-section].
24
26
*[Serialization][serializers] that supports both [ORM][modelserializer-section] and [non-ORM][serializer-section] data sources.
25
27
* Customizable all the way down - just use [regular function-based views][functionview-section] if you don't need the [more][generic-views][powerful][viewsets][features][routers].
26
-
*[Extensive documentation][index], and [great community support][group].
28
+
*[Extensive documentation][docs], and [great community support][group].
27
29
28
30
There is a live example API for testing purposes, [available here][sandbox].
29
31
@@ -186,10 +188,8 @@ OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
Copy file name to clipboardExpand all lines: docs/api-guide/fields.md
-6
Original file line number
Diff line number
Diff line change
@@ -1,11 +1,5 @@
1
1
source: fields.py
2
2
3
-
---
4
-
5
-
**Note**: This is the documentation for the **version 3.0** of REST framework. Documentation for [version 2.4](http://tomchristie.github.io/rest-framework-2-docs/) is also available.
6
-
7
-
---
8
-
9
3
# Serializer fields
10
4
11
5
> Each field in a Form class is responsible not only for validating data, but also for "cleaning" it — normalizing it to a consistent format.
**Note**: This is the documentation for the **version 3.0** of REST framework. Documentation for [version 2.4](http://tomchristie.github.io/rest-framework-2-docs/) is also available.
7
-
8
-
---
9
-
10
4
# Generic views
11
5
12
6
> Django’s generic views... were developed as a shortcut for common usage patterns... They take certain common idioms and patterns found in view development and abstract them so that you can quickly write common views of data without having to repeat yourself.
Copy file name to clipboardExpand all lines: docs/api-guide/metadata.md
+1-7
Original file line number
Diff line number
Diff line change
@@ -1,11 +1,5 @@
1
1
source: metadata.py
2
2
3
-
---
4
-
5
-
**Note**: This is the documentation for the **version 3.0** of REST framework. Documentation for [version 2.4](http://tomchristie.github.io/rest-framework-2-docs/) is also available.
6
-
7
-
---
8
-
9
3
# Metadata
10
4
11
5
> [The `OPTIONS`] method allows a client to determine the options and/or requirements associated with a resource, or the capabilities of a server, without implying a resource action or initiating a resource retrieval.
@@ -59,7 +53,7 @@ Or you can set the metadata class individually for a view:
Copy file name to clipboardExpand all lines: docs/api-guide/relations.md
-6
Original file line number
Diff line number
Diff line change
@@ -1,11 +1,5 @@
1
1
source: relations.py
2
2
3
-
---
4
-
5
-
**Note**: This is the documentation for the **version 3.0** of REST framework. Documentation for [version 2.4](http://tomchristie.github.io/rest-framework-2-docs/) is also available.
Copy file name to clipboardExpand all lines: docs/api-guide/requests.md
-6
Original file line number
Diff line number
Diff line change
@@ -1,11 +1,5 @@
1
1
source: request.py
2
2
3
-
---
4
-
5
-
**Note**: This is the documentation for the **version 3.0** of REST framework. Documentation for [version 2.4](http://tomchristie.github.io/rest-framework-2-docs/) is also available.
6
-
7
-
---
8
-
9
3
# Requests
10
4
11
5
> If you're doing REST-based web service stuff ... you should ignore request.POST.
Copy file name to clipboardExpand all lines: docs/api-guide/serializers.md
+1-7
Original file line number
Diff line number
Diff line change
@@ -1,11 +1,5 @@
1
1
source: serializers.py
2
2
3
-
---
4
-
5
-
**Note**: This is the documentation for the **version 3.0** of REST framework. Documentation for [version 2.4](http://tomchristie.github.io/rest-framework-2-docs/) is also available.
6
-
7
-
---
8
-
9
3
# Serializers
10
4
11
5
> Expanding the usefulness of the serializers is something that we would
@@ -23,7 +17,7 @@ The serializers in REST framework work very similarly to Django's `Form` and `Mo
23
17
Let's start by creating a simple object we can use for example purposes:
Copy file name to clipboardExpand all lines: docs/api-guide/validators.md
+4-10
Original file line number
Diff line number
Diff line change
@@ -1,11 +1,5 @@
1
1
source: validators.py
2
2
3
-
---
4
-
5
-
**Note**: This is the documentation for the **version 3.0** of REST framework. Documentation for [version 2.4](http://tomchristie.github.io/rest-framework-2-docs/) is also available.
6
-
7
-
---
8
-
9
3
# Validators
10
4
11
5
> Validators can be useful for re-using validation logic between different types of fields.
@@ -33,7 +27,7 @@ When you're using `ModelSerializer` all of this is handled automatically for you
33
27
As an example of how REST framework uses explicit validation, we'll take a simple model class that has a field with a uniqueness constraint.
Copy file name to clipboardExpand all lines: docs/index.md
+2-2
Original file line number
Diff line number
Diff line change
@@ -9,9 +9,9 @@
9
9
10
10
---
11
11
12
-
**Note**: This is the documentation for the **version 3.0** of REST framework. Documentation for [version 2.4](http://tomchristie.github.io/rest-framework-2-docs/) is also available.
12
+
**Note**: This is the documentation for the **version 3.1** of REST framework. Documentation for [version 2.4](http://tomchristie.github.io/rest-framework-2-docs/) is also available.
13
13
14
-
For more details see the [3.0 release notes][3.0-announcement].
14
+
For more details see the [3.1 release notes][3.1-announcement].
0 commit comments