|
4 | 4 |
|
5 | 5 | [![build-status-image]][travis]
|
6 | 6 |
|
7 |
| ---- |
8 |
| - |
9 |
| -**Full documentation for REST framework is available on [http://django-rest-framework.org][docs].** |
10 |
| - |
11 |
| ---- |
| 7 | +**Note**: Full documentation for the project is available at [http://django-rest-framework.org][docs]. |
12 | 8 |
|
13 | 9 | # Overview
|
14 | 10 |
|
15 | 11 | Django REST framework is a powerful and flexible toolkit that makes it easy to build Web APIs.
|
16 | 12 |
|
17 |
| -Web APIs built using REST framework are fully self-describing and web browseable - a huge useability win for your developers. It also supports a wide range of media types, authentication and permission policies out of the box. |
| 13 | +Some reasons you might want to use REST framework: |
18 | 14 |
|
19 |
| -If you are considering using REST framework for your API, we recommend reading the [REST framework 2 announcment][rest-framework-2-announcement] which gives a good overview of the framework and it's capabilities. |
| 15 | +* Modular and decoupled architecture that stays close to Django idioms throughout. |
| 16 | +* The Web browseable API is a huge useability win for your developers. |
| 17 | +* Authentication policies including OAuth1a and OAuth2 out of the box. |
| 18 | +* Permission policies including support for the Django contrib permissions. |
| 19 | +* Serialization that supports both ORM and non-ORM data sources. |
| 20 | +* Customizable all the way down. You can just use regular function based views if you don't need the more powerful features. |
| 21 | +* Extensive documentation, and great community support. |
20 | 22 |
|
21 |
| -There is also a sandbox API you can use for testing purposes, [available here][sandbox]. |
| 23 | +There is a live example API for testing purposes, [available here][sandbox]. |
22 | 24 |
|
23 | 25 | **Below**: *Screenshot from the browseable API*
|
24 | 26 |
|
@@ -86,11 +88,11 @@ Here's our project's root `urls.py` module:
|
86 | 88 |
|
87 | 89 | # Documentation & Support
|
88 | 90 |
|
89 |
| -The full documentation for the project is available at [http://django-rest-framework.org][docs]. |
| 91 | +Full documentation for the project is available at [http://django-rest-framework.org][docs]. |
90 | 92 |
|
91 | 93 | For questions and support, use the [REST framework discussion group][group], or `#restframework` on freenode IRC.
|
92 | 94 |
|
93 |
| -You may also want to [follow the author on Twitter][twitter] . |
| 95 | +You may also want to [follow the author on Twitter][twitter]. |
94 | 96 |
|
95 | 97 | # License
|
96 | 98 |
|
@@ -129,6 +131,10 @@ OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
129 | 131 |
|
130 | 132 | [tox]: http://testrun.org/tox/latest/
|
131 | 133 |
|
| 134 | +[tehjones]: https://twitter.com/tehjones/status/294986071979196416 |
| 135 | +[wlonk]: https://twitter.com/wlonk/status/261689665952833536 |
| 136 | +[laserllama]: https://twitter.com/laserllama/status/328688333750407168 |
| 137 | + |
132 | 138 | [docs]: http://django-rest-framework.org/
|
133 | 139 | [urlobject]: https://github.com/zacharyvoase/urlobject
|
134 | 140 | [markdown]: http://pypi.python.org/pypi/Markdown/
|
|
0 commit comments