mirror of
https://github.com/encode/django-rest-framework.git
synced 2024-11-15 06:07:41 +03:00
55 lines
3.4 KiB
Markdown
55 lines
3.4 KiB
Markdown
# REST, Hypermedia & HATEOAS
|
|
|
|
> You keep using that word "REST". I do not think it means what you think it means.
|
|
>
|
|
> — Mike Amundsen, [REST fest 2012 keynote][cite].
|
|
|
|
First off, the disclaimer. The name "Django REST framework" was decided back in early 2011 and was chosen simply to ensure the project would be easily found by developers. Throughout the documentation we try to use the more simple and technically correct terminology of "Web APIs".
|
|
|
|
If you are serious about designing a Hypermedia API, you should look to resources outside of this documentation to help inform your design choices.
|
|
|
|
The following fall into the "required reading" category.
|
|
|
|
* Roy Fielding's dissertation - [Architectural Styles and
|
|
the Design of Network-based Software Architectures][dissertation].
|
|
* Roy Fielding's "[REST APIs must be hypertext-driven][hypertext-driven]" blog post.
|
|
* Leonard Richardson & Mike Amundsen's [RESTful Web APIs][restful-web-apis].
|
|
* Mike Amundsen's [Building Hypermedia APIs with HTML5 and Node][building-hypermedia-apis].
|
|
* Steve Klabnik's [Designing Hypermedia APIs][designing-hypermedia-apis].
|
|
* The [Richardson Maturity Model][maturitymodel].
|
|
|
|
For a more thorough background, check out Klabnik's [Hypermedia API reading list][readinglist].
|
|
|
|
## Building Hypermedia APIs with REST framework
|
|
|
|
REST framework is an agnostic Web API toolkit. It does help guide you towards building well-connected APIs, and makes it easy to design appropriate media types, but it does not strictly enforce any particular design style.
|
|
|
|
## What REST framework provides.
|
|
|
|
It is self evident that REST framework makes it possible to build Hypermedia APIs. The browsable API that it offers is built on HTML - the hypermedia language of the web.
|
|
|
|
REST framework also includes [serialization] and [parser]/[renderer] components that make it easy to build appropriate media types, [hyperlinked relations][fields] for building well-connected systems, and great support for [content negotiation][conneg].
|
|
|
|
## What REST framework doesn't provide.
|
|
|
|
What REST framework doesn't do is give you 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]: https://vimeo.com/channels/restfest/49503453
|
|
[dissertation]: https://www.ics.uci.edu/~fielding/pubs/dissertation/top.htm
|
|
[hypertext-driven]: https://roy.gbiv.com/untangled/2008/rest-apis-must-be-hypertext-driven
|
|
[restful-web-apis]: http://restfulwebapis.org/
|
|
[building-hypermedia-apis]: https://www.amazon.com/Building-Hypermedia-APIs-HTML5-Node/dp/1449306578
|
|
[designing-hypermedia-apis]: http://designinghypermediaapis.com/
|
|
[readinglist]: http://blog.steveklabnik.com/posts/2012-02-27-hypermedia-api-reading-list
|
|
[maturitymodel]: https://martinfowler.com/articles/richardsonMaturityModel.html
|
|
|
|
[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
|
|
[renderer]: ../api-guide/renderers.md
|
|
[fields]: ../api-guide/fields.md
|
|
[conneg]: ../api-guide/content-negotiation.md
|