2014-12-18 18:42:42 +03:00
<!DOCTYPE html>
< html lang = "en" >
< head >
< meta http-equiv = "Content-Type" content = "text/html; charset=UTF-8" >
< meta charset = "utf-8" >
2015-05-14 12:03:42 +03:00
< title > Metadata< / title >
2014-12-18 18:42:42 +03:00
< link href = "../../img/favicon.ico" rel = "icon" type = "image/x-icon" >
< link rel = "canonical" href = "http://www.django-rest-framework.org/api-guide/metadata/" / >
< meta name = "viewport" content = "width=device-width, initial-scale=1.0" >
< meta name = "description" content = "Django, API, REST, Metadata" >
< meta name = "author" content = "Tom Christie" >
<!-- Le styles -->
< link href = "../../css/prettify.css" rel = "stylesheet" >
< link href = "../../css/bootstrap.css" rel = "stylesheet" >
< link href = "../../css/bootstrap-responsive.css" rel = "stylesheet" >
< link href = "../../css/default.css" rel = "stylesheet" >
<!-- Le HTML5 shim, for IE6 - 8 support of HTML5 elements -->
<!-- [if lt IE 9]>
< script src = "http://html5shim.googlecode.com/svn/trunk/html5.js" > < / script >
<![endif]-->
< script type = "text/javascript" >
var _gaq = _gaq || [];
_gaq.push(['_setAccount', 'UA-18852272-2']);
_gaq.push(['_trackPageview']);
(function() {
var ga = document.createElement('script');
ga.type = 'text/javascript';
ga.async = true;
ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';
var s = document.getElementsByTagName('script')[0];
s.parentNode.insertBefore(ga, s);
})();
< / script >
< style >
span.fusion-wrap a {
display: block;
margin-top: 10px;
color: black;
}
a.fusion-poweredby {
display: block;
margin-top: 10px;
}
@media (max-width: 767px) {
div.promo {
display: none;
}
}
< / style >
< / head >
< body onload = "prettyPrint()" class = "-page" >
< div class = "wrapper" >
< div class = "navbar navbar-inverse navbar-fixed-top" >
< div class = "navbar-inner" >
< div class = "container-fluid" >
< a class = "repo-link btn btn-primary btn-small" href = "https://github.com/tomchristie/django-rest-framework/tree/master" > GitHub< / a >
2015-05-14 12:03:42 +03:00
< a class = "repo-link btn btn-inverse btn-small " rel = "prev" href = "../format-suffixes/" >
2014-12-18 18:42:42 +03:00
Next < i class = "icon-arrow-right icon-white" > < / i >
< / a >
2015-05-14 12:03:42 +03:00
< a class = "repo-link btn btn-inverse btn-small " rel = "next" href = "../content-negotiation/" >
2014-12-18 18:42:42 +03:00
< i class = "icon-arrow-left icon-white" > < / i > Previous
< / a >
< a class = "repo-link btn btn-inverse btn-small" href = "#searchModal" data-toggle = "modal" > < i class = "icon-search icon-white" > < / i > Search< / a >
< a class = "btn btn-navbar" data-toggle = "collapse" data-target = ".nav-collapse" >
< span class = "icon-bar" > < / span >
< span class = "icon-bar" > < / span >
< span class = "icon-bar" > < / span >
< / a >
< a class = "brand" href = "http://www.django-rest-framework.org" > Django REST framework< / a >
< div class = "nav-collapse collapse" >
<!-- Main navigation -->
< ul class = "nav navbar-nav" >
< li > < a href = "/" > Home< / a > < / li >
2015-05-14 12:03:42 +03:00
< li >
< a href = "../.." > Home< / a >
< / li >
2014-12-18 18:42:42 +03:00
< li class = "dropdown" >
< a href = "#" class = "dropdown-toggle" data-toggle = "dropdown" > Tutorial < b class = "caret" > < / b > < / a >
< ul class = "dropdown-menu" >
< li >
2015-05-14 12:03:42 +03:00
< a href = "../../tutorial/quickstart/" > Quickstart< / a >
2014-12-18 18:42:42 +03:00
< / li >
< li >
2015-05-14 12:03:42 +03:00
< a href = "../../tutorial/1-serialization/" > 1 - Serialization< / a >
2014-12-18 18:42:42 +03:00
< / li >
< li >
2015-05-14 12:03:42 +03:00
< a href = "../../tutorial/2-requests-and-responses/" > 2 - Requests and responses< / a >
2014-12-18 18:42:42 +03:00
< / li >
< li >
2015-05-14 12:03:42 +03:00
< a href = "../../tutorial/3-class-based-views/" > 3 - Class based views< / a >
2014-12-18 18:42:42 +03:00
< / li >
< li >
2015-05-14 12:03:42 +03:00
< a href = "../../tutorial/4-authentication-and-permissions/" > 4 - Authentication and permissions< / a >
2014-12-18 18:42:42 +03:00
< / li >
< li >
2015-05-14 12:03:42 +03:00
< a href = "../../tutorial/5-relationships-and-hyperlinked-apis/" > 5 - Relationships and hyperlinked APIs< / a >
2014-12-18 18:42:42 +03:00
< / li >
< li >
2015-05-14 12:03:42 +03:00
< a href = "../../tutorial/6-viewsets-and-routers/" > 6 - Viewsets and routers< / a >
2014-12-18 18:42:42 +03:00
< / li >
< / ul >
< / li >
< li class = "dropdown active" >
< a href = "#" class = "dropdown-toggle" data-toggle = "dropdown" > API Guide < b class = "caret" > < / b > < / a >
< ul class = "dropdown-menu" >
< li >
2015-05-14 12:03:42 +03:00
< a href = "../requests/" > Requests< / a >
2014-12-18 18:42:42 +03:00
< / li >
< li >
2015-05-14 12:03:42 +03:00
< a href = "../responses/" > Responses< / a >
2014-12-18 18:42:42 +03:00
< / li >
< li >
2015-05-14 12:03:42 +03:00
< a href = "../views/" > Views< / a >
2014-12-18 18:42:42 +03:00
< / li >
< li >
2015-05-14 12:03:42 +03:00
< a href = "../generic-views/" > Generic views< / a >
2014-12-18 18:42:42 +03:00
< / li >
< li >
2015-05-14 12:03:42 +03:00
< a href = "../viewsets/" > Viewsets< / a >
2014-12-18 18:42:42 +03:00
< / li >
< li >
2015-05-14 12:03:42 +03:00
< a href = "../routers/" > Routers< / a >
2014-12-18 18:42:42 +03:00
< / li >
< li >
2015-05-14 12:03:42 +03:00
< a href = "../parsers/" > Parsers< / a >
2014-12-18 18:42:42 +03:00
< / li >
< li >
2015-05-14 12:03:42 +03:00
< a href = "../renderers/" > Renderers< / a >
2014-12-18 18:42:42 +03:00
< / li >
< li >
2015-05-14 12:03:42 +03:00
< a href = "../serializers/" > Serializers< / a >
2014-12-18 18:42:42 +03:00
< / li >
< li >
2015-05-14 12:03:42 +03:00
< a href = "../fields/" > Serializer fields< / a >
2014-12-18 18:42:42 +03:00
< / li >
< li >
2015-05-14 12:03:42 +03:00
< a href = "../relations/" > Serializer relations< / a >
2014-12-18 18:42:42 +03:00
< / li >
< li >
2015-05-14 12:03:42 +03:00
< a href = "../validators/" > Validators< / a >
2014-12-18 18:42:42 +03:00
< / li >
< li >
2015-05-14 12:03:42 +03:00
< a href = "../authentication/" > Authentication< / a >
2014-12-18 18:42:42 +03:00
< / li >
< li >
2015-05-14 12:03:42 +03:00
< a href = "../permissions/" > Permissions< / a >
2014-12-18 18:42:42 +03:00
< / li >
< li >
2015-05-14 12:03:42 +03:00
< a href = "../throttling/" > Throttling< / a >
2014-12-18 18:42:42 +03:00
< / li >
< li >
2015-05-14 12:03:42 +03:00
< a href = "../filtering/" > Filtering< / a >
2014-12-18 18:42:42 +03:00
< / li >
< li >
2015-05-14 12:03:42 +03:00
< a href = "../pagination/" > Pagination< / a >
2014-12-18 18:42:42 +03:00
< / li >
2015-03-06 15:05:16 +03:00
< li >
2015-05-14 12:03:42 +03:00
< a href = "../versioning/" > Versioning< / a >
2015-03-06 15:05:16 +03:00
< / li >
2014-12-18 18:42:42 +03:00
< li >
2015-05-14 12:03:42 +03:00
< a href = "../content-negotiation/" > Content negotiation< / a >
2014-12-18 18:42:42 +03:00
< / li >
< li class = "active" >
2015-05-14 12:03:42 +03:00
< a href = "./" > Metadata< / a >
2014-12-18 18:42:42 +03:00
< / li >
< li >
2015-05-14 12:03:42 +03:00
< a href = "../format-suffixes/" > Format suffixes< / a >
2014-12-18 18:42:42 +03:00
< / li >
< li >
2015-05-14 12:03:42 +03:00
< a href = "../reverse/" > Returning URLs< / a >
2014-12-18 18:42:42 +03:00
< / li >
< li >
2015-05-14 12:03:42 +03:00
< a href = "../exceptions/" > Exceptions< / a >
2014-12-18 18:42:42 +03:00
< / li >
< li >
2015-05-14 12:03:42 +03:00
< a href = "../status-codes/" > Status codes< / a >
2014-12-18 18:42:42 +03:00
< / li >
< li >
2015-05-14 12:03:42 +03:00
< a href = "../testing/" > Testing< / a >
2014-12-18 18:42:42 +03:00
< / li >
< li >
2015-05-14 12:03:42 +03:00
< a href = "../settings/" > Settings< / a >
2014-12-18 18:42:42 +03:00
< / li >
< / ul >
< / li >
< li class = "dropdown" >
< a href = "#" class = "dropdown-toggle" data-toggle = "dropdown" > Topics < b class = "caret" > < / b > < / a >
< ul class = "dropdown-menu" >
< li >
2015-05-14 12:03:42 +03:00
< a href = "../../topics/documenting-your-api/" > Documenting your API< / a >
2014-12-18 18:42:42 +03:00
< / li >
2015-03-06 15:05:16 +03:00
< li >
2015-05-14 12:03:42 +03:00
< a href = "../../topics/internationalization/" > Internationalization< / a >
2015-03-06 15:05:16 +03:00
< / li >
2014-12-18 18:42:42 +03:00
< li >
2015-05-14 12:03:42 +03:00
< a href = "../../topics/ajax-csrf-cors/" > AJAX, CSRF & CORS< / a >
2014-12-18 18:42:42 +03:00
< / li >
< li >
2015-05-14 12:03:42 +03:00
< a href = "../../topics/browser-enhancements/" > Browser enhancements< / a >
2014-12-18 18:42:42 +03:00
< / li >
< li >
2015-05-14 12:03:42 +03:00
< a href = "../../topics/browsable-api/" > The Browsable API< / a >
2014-12-18 18:42:42 +03:00
< / li >
< li >
2015-05-14 12:03:42 +03:00
< a href = "../../topics/rest-hypermedia-hateoas/" > REST, Hypermedia & HATEOAS< / a >
2014-12-18 18:42:42 +03:00
< / li >
< li >
2015-05-14 12:03:42 +03:00
< a href = "../../topics/third-party-resources/" > Third Party Resources< / a >
2014-12-18 18:42:42 +03:00
< / li >
< li >
2015-05-14 12:03:42 +03:00
< a href = "../../topics/contributing/" > Contributing to REST framework< / a >
2014-12-18 18:42:42 +03:00
< / li >
< li >
2015-05-14 12:03:42 +03:00
< a href = "../../topics/project-management/" > Project management< / a >
2014-12-18 18:42:42 +03:00
< / li >
< li >
2015-05-14 12:03:42 +03:00
< a href = "../../topics/3.0-announcement/" > 3.0 Announcement< / a >
2014-12-18 18:42:42 +03:00
< / li >
< li >
2015-05-14 12:03:42 +03:00
< a href = "../../topics/3.1-announcement/" > 3.1 Announcement< / a >
2014-12-18 18:42:42 +03:00
< / li >
< li >
2015-05-14 12:03:42 +03:00
< a href = "../../topics/kickstarter-announcement/" > Kickstarter Announcement< / a >
2014-12-18 18:42:42 +03:00
< / li >
< li >
2015-05-14 12:03:42 +03:00
< a href = "../../topics/release-notes/" > Release Notes< / a >
2014-12-18 18:42:42 +03:00
< / li >
< / ul >
< / li >
< / ul >
< / div >
<!-- /.nav - collapse -->
< / div >
< / div >
< / div >
< div class = "body-content" >
< div class = "container-fluid" >
<!-- Search Modal -->
< div id = "searchModal" class = "modal hide fade" tabindex = "-1" role = "dialog" aria-labelledby = "myModalLabel" aria-hidden = "true" >
< div class = "modal-header" >
< button type = "button" class = "close" data-dismiss = "modal" aria-hidden = "true" > × < / button >
< h3 id = "myModalLabel" > Documentation search< / h3 >
< / div >
< div class = "modal-body" >
<!-- Custom google search -->
< script >
(function() {
var cx = '015016005043623903336:rxraeohqk6w';
var gcse = document.createElement('script');
gcse.type = 'text/javascript';
gcse.async = true;
gcse.src = (document.location.protocol == 'https:' ? 'https:' : 'http:') +
'//www.google.com/cse/cse.js?cx=' + cx;
var s = document.getElementsByTagName('script')[0];
s.parentNode.insertBefore(gcse, s);
})();
< / script >
< gcse:search > < / gcse:search >
< / div >
< div class = "modal-footer" >
< button class = "btn" data-dismiss = "modal" aria-hidden = "true" > Close< / button >
< / div >
< / div >
< div class = "row-fluid" >
< div class = "span3" >
<!-- TODO
< p style = "margin-top: -12px" >
< a class = "btn btn-mini btn-primary" style = "width: 60px" > « previous< / a >
< a class = "btn btn-mini btn-primary" style = "float: right; margin-right: 8px; width: 60px;" > next » < / a >
< / p >
-->
< div id = "table-of-contents" >
< ul class = "nav nav-list side-nav well sidebar-nav-fixed" >
< li class = "main" >
< a href = "#metadata" > Metadata< / a >
< / li >
< li >
< a href = "#setting-the-metadata-scheme" > Setting the metadata scheme< / a >
< / li >
< li >
< a href = "#creating-schema-endpoints" > Creating schema endpoints< / a >
< / li >
< li class = "main" >
< a href = "#custom-metadata-classes" > Custom metadata classes< / a >
< / li >
< li >
< a href = "#example" > Example< / a >
< / li >
< / ul >
< / div >
< / div >
< div id = "main-content" class = "span9" >
< a class = "github" href = "https://github.com/tomchristie/django-rest-framework/tree/master/rest_framework/metadata.py" >
< span class = "label label-info" > metadata.py< / span >
< / a >
2015-03-09 13:18:32 +03:00
< h1 id = "metadata" > Metadata< / h1 >
2014-12-18 18:42:42 +03:00
< blockquote >
< p > [The < code > OPTIONS< / code > ] 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.< / p >
< p > — < a href = "http://tools.ietf.org/html/rfc7231#section-4.3.7" > RFC7231, Section 4.3.7.< / a > < / p >
< / blockquote >
< p > REST framework includes a configurable mechanism for determining how your API should respond to < code > OPTIONS< / code > requests. This allows you to return API schema or other resource information.< / p >
< p > There are not currently any widely adopted conventions for exactly what style of response should be returned for HTTP < code > OPTIONS< / code > requests, so we provide an ad-hoc style that returns some useful information.< / p >
< p > Here's an example response that demonstrates the information that is returned by default.< / p >
< pre > < code > HTTP 200 OK
Allow: GET, POST, HEAD, OPTIONS
Content-Type: application/json
{
"name": "To Do List",
"description": "List existing 'To Do' items, or create a new item.",
"renders": [
"application/json",
"text/html"
],
"parses": [
"application/json",
"application/x-www-form-urlencoded",
"multipart/form-data"
],
"actions": {
"POST": {
"note": {
"type": "string",
"required": false,
"read_only": false,
"label": "title",
"max_length": 100
}
}
}
}
< / code > < / pre >
< h2 id = "setting-the-metadata-scheme" > Setting the metadata scheme< / h2 >
< p > You can set the metadata class globally using the < code > 'DEFAULT_METADATA_CLASS'< / code > settings key:< / p >
< pre > < code > REST_FRAMEWORK = {
'DEFAULT_METADATA_CLASS': 'rest_framework.metadata.SimpleMetadata'
}
< / code > < / pre >
< p > Or you can set the metadata class individually for a view:< / p >
< pre > < code > class APIRoot(APIView):
metadata_class = APIRootMetadata
def get(self, request, format=None):
return Response({
...
})
< / code > < / pre >
< p > The REST framework package only includes a single metadata class implementation, named < code > SimpleMetadata< / code > . If you want to use an alternative style you'll need to implement a custom metadata class.< / p >
< h2 id = "creating-schema-endpoints" > Creating schema endpoints< / h2 >
< p > If you have specific requirements for creating schema endpoints that are accessed with regular < code > GET< / code > requests, you might consider re-using the metadata API for doing so.< / p >
< p > For example, the following additional route could be used on a viewset to provide a linkable schema endpoint.< / p >
< pre > < code > @list_route(methods=['GET'])
def schema(self, request):
meta = self.metadata_class()
data = meta.determine_metadata(request, self)
return Response(data)
< / code > < / pre >
< p > There are a couple of reasons that you might choose to take this approach, including that < code > OPTIONS< / code > responses < a href = "https://www.mnot.net/blog/2012/10/29/NO_OPTIONS" > are not cacheable< / a > .< / p >
< hr / >
< h1 id = "custom-metadata-classes" > Custom metadata classes< / h1 >
< p > If you want to provide a custom metadata class you should override < code > BaseMetadata< / code > and implement the < code > determine_metadata(self, request, view)< / code > method.< / p >
< p > Useful things that you might want to do could include returning schema information, using a format such as < a href = "http://json-schema.org/" > JSON schema< / a > , or returning debug information to admin users.< / p >
< h2 id = "example" > Example< / h2 >
< p > The following class could be used to limit the information that is returned to < code > OPTIONS< / code > requests.< / p >
< pre > < code > class MinimalMetadata(BaseMetadata):
"""
Don't include field and other information for `OPTIONS` requests.
Just return the name and description.
"""
def determine_metadata(self, request, view):
return {
'name': view.get_view_name(),
'description': view.get_view_description()
}
< / code > < / pre >
< / div >
<!-- /span -->
< / div >
<!-- /row -->
< / div >
<!-- /.fluid - container -->
< / div >
<!-- /.body content -->
< div id = "push" > < / div >
< / div >
<!-- /.wrapper -->
< footer class = "span12" >
< p > Documentation built with < a href = "http://www.mkdocs.org/" > MkDocs< / a > .< / a >
< / p >
< / footer >
<!-- Le javascript
================================================== -->
<!-- Placed at the end of the document so the pages load faster -->
< script src = "../../js/jquery-1.8.1-min.js" > < / script >
< script src = "../../js/prettify-1.0.js" > < / script >
< script src = "../../js/bootstrap-2.1.1-min.js" > < / script >
< script src = "../../js/theme.js" > < / script >
< script >
//$('.side-nav').scrollspy()
var shiftWindow = function() {
scrollBy(0, -50)
};
if (location.hash) shiftWindow();
window.addEventListener("hashchange", shiftWindow);
$('.dropdown-menu').on('click touchstart', function(event) {
event.stopPropagation();
});
// Dynamically force sidenav to no higher than browser window
$('.side-nav').css('max-height', window.innerHeight - 130);
$(function() {
$(window).resize(function() {
$('.side-nav').css('max-height', window.innerHeight - 130);
});
});
< / script >
< / body >
< / html >
