diff options
| author | Tom Christie | 2013-07-02 22:15:46 +0100 |
|---|---|---|
| committer | Tom Christie | 2013-07-02 22:15:46 +0100 |
| commit | 03e0ce35fe497d52d1a332e98c44e42acbc8af75 (patch) | |
| tree | a37a2b2481e408ceef357a83dd7b5fab74ff3a4a /docs/topics/rest-hypermedia-hateoas.md | |
| parent | e7529b4072274797daf5b886dbac4c0e65a65674 (diff) | |
| download | django-rest-framework-03e0ce35fe497d52d1a332e98c44e42acbc8af75.tar.bz2 | |
Added 'Documenting your API' section. Closes #616
Diffstat (limited to 'docs/topics/rest-hypermedia-hateoas.md')
| -rw-r--r-- | docs/topics/rest-hypermedia-hateoas.md | 3 |
1 files changed, 2 insertions, 1 deletions
diff --git a/docs/topics/rest-hypermedia-hateoas.md b/docs/topics/rest-hypermedia-hateoas.md index b4899a36..3d700488 100644 --- a/docs/topics/rest-hypermedia-hateoas.md +++ b/docs/topics/rest-hypermedia-hateoas.md @@ -32,7 +32,7 @@ REST framework also includes [serialization] and [parser]/[renderer] components ## What REST framework doesn't provide. -What REST framework doesn't do is give you is machine readable hypermedia formats such as [HAL][hal], [Collection+JSON][collection] or HTML [microformats] by default, or the ability to auto-magically create fully HATEOAS style APIs that include hypermedia-based form descriptions and semantically labelled hyperlinks. Doing so would involve making opinionated choices about API design that should really remain outside of the framework's scope. +What REST framework doesn't do is give you is machine readable hypermedia formats such as [HAL][hal], [Collection+JSON][collection], [JSON API][json-api] or HTML [microformats] by default, or the ability to auto-magically create fully HATEOAS style APIs that include hypermedia-based form descriptions and semantically labelled hyperlinks. Doing so would involve making opinionated choices about API design that should really remain outside of the framework's scope. [cite]: http://vimeo.com/channels/restfest/page:2 [dissertation]: http://www.ics.uci.edu/~fielding/pubs/dissertation/top.htm @@ -46,6 +46,7 @@ What REST framework doesn't do is give you is machine readable hypermedia format [hal]: http://stateless.co/hal_specification.html [collection]: http://www.amundsen.com/media-types/collection/ +[json-api]: http://jsonapi.org/ [microformats]: http://microformats.org/wiki/Main_Page [serialization]: ../api-guide/serializers.md [parser]: ../api-guide/parsers.md |