From ef41828866b769fab832cab4e67e1f4514400ddc Mon Sep 17 00:00:00 2001 From: Tom Christie Date: Fri, 15 Aug 2014 12:06:22 +0100 Subject: [PATCH] Update title - Easy is a sucky word choice --- index.html | 2 +- topics/documenting-your-api.html | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/index.html b/index.html index 2543b0928..e2cea0aa0 100644 --- a/index.html +++ b/index.html @@ -2,7 +2,7 @@ - Django REST framework - APIs made easy + Django REST framework - Web APIs for Django diff --git a/topics/documenting-your-api.html b/topics/documenting-your-api.html index 2dbc4a604..0a1c7997c 100644 --- a/topics/documenting-your-api.html +++ b/topics/documenting-your-api.html @@ -257,7 +257,7 @@ a.fusion-poweredby {

The hypermedia approach

To be fully RESTful an API should present its available actions as hypermedia controls in the responses that it sends.

-

In this approach, rather than documenting the available API endpoints up front, the description instead concentrates on the media types that are used. The available actions take may be taken on any given URL are not strictly fixed, but are instead made available by the presence of link and form controls in the returned document.

+

In this approach, rather than documenting the available API endpoints up front, the description instead concentrates on the media types that are used. The available actions that may be taken on any given URL are not strictly fixed, but are instead made available by the presence of link and form controls in the returned document.

To implement a hypermedia API you'll need to decide on an appropriate media type for the API, and implement a custom renderer and parser for that media type. The REST, Hypermedia & HATEOAS section of the documentation includes pointers to background reading, as well as links to various hypermedia formats.