2016-07-07 11:41:32 +03:00
<!DOCTYPE html>
< html lang = "en" >
< head >
< meta http-equiv = "Content-Type" content = "text/html; charset=UTF-8" >
< meta charset = "utf-8" >
< title > Schemas - Django REST framework< / title >
< link href = "../../img/favicon.ico" rel = "icon" type = "image/x-icon" >
2018-10-11 16:48:33 +03:00
< link rel = "canonical" href = "https://www.django-rest-framework.org/api-guide/schemas/" / >
2016-07-07 11:41:32 +03:00
< meta name = "viewport" content = "width=device-width, initial-scale=1.0" >
< meta name = "description" content = "Django, API, REST, Schemas" >
< 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 >
#sidebarInclude img {
margin-bottom: 10px;
}
#sidebarInclude a.promo {
color: black;
}
@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" >
2017-05-12 19:15:00 +03:00
< a class = "repo-link btn btn-primary btn-small" href = "https://github.com/encode/django-rest-framework/tree/master" > GitHub< / a >
2019-07-15 22:12:34 +03:00
< a class = "repo-link btn btn-inverse btn-small " rel = "next" href = "../format-suffixes/" >
2016-07-07 11:41:32 +03:00
Next < i class = "icon-arrow-right icon-white" > < / i >
< / a >
2019-07-15 22:12:34 +03:00
< a class = "repo-link btn btn-inverse btn-small " rel = "prev" href = "../metadata/" >
2016-07-07 11:41:32 +03:00
< i class = "icon-arrow-left icon-white" > < / i > Previous
< / a >
< a id = "search_modal_show" class = "repo-link btn btn-inverse btn-small" href = "#mkdocs_search_modal" data-toggle = "modal" data-target = "#mkdocs_search_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 >
2018-10-11 16:48:33 +03:00
< a class = "brand" href = "https://www.django-rest-framework.org/" > Django REST framework< / a >
2016-07-07 11:41:32 +03:00
< div class = "nav-collapse collapse" >
<!-- Main navigation -->
< ul class = "nav navbar-nav" >
< li >
2019-07-15 22:12:34 +03:00
< a href = "../.." > Home< / a >
2016-07-07 11:41:32 +03:00
< / li >
< li class = "dropdown" >
< a href = "#" class = "dropdown-toggle" data-toggle = "dropdown" > Tutorial < b class = "caret" > < / b > < / a >
< ul class = "dropdown-menu" >
< li >
2019-07-15 22:12:34 +03:00
< a href = "../../tutorial/quickstart/" > Quickstart< / a >
2016-07-07 11:41:32 +03:00
< / li >
< li >
2019-07-15 22:12:34 +03:00
< a href = "../../tutorial/1-serialization/" > 1 - Serialization< / a >
2016-07-07 11:41:32 +03:00
< / li >
< li >
2019-07-15 22:12:34 +03:00
< a href = "../../tutorial/2-requests-and-responses/" > 2 - Requests and responses< / a >
2016-07-07 11:41:32 +03:00
< / li >
< li >
2019-07-15 22:12:34 +03:00
< a href = "../../tutorial/3-class-based-views/" > 3 - Class based views< / a >
2016-07-07 11:41:32 +03:00
< / li >
< li >
2019-07-15 22:12:34 +03:00
< a href = "../../tutorial/4-authentication-and-permissions/" > 4 - Authentication and permissions< / a >
2016-07-07 11:41:32 +03:00
< / li >
< li >
2019-07-15 22:12:34 +03:00
< a href = "../../tutorial/5-relationships-and-hyperlinked-apis/" > 5 - Relationships and hyperlinked APIs< / a >
2016-07-07 11:41:32 +03:00
< / li >
< li >
2019-07-15 22:12:34 +03:00
< a href = "../../tutorial/6-viewsets-and-routers/" > 6 - Viewsets and routers< / a >
2016-07-14 15:05:57 +03:00
< / li >
2016-07-07 11:41:32 +03:00
< / 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 >
2019-07-15 22:12:34 +03:00
< a href = "../requests/" > Requests< / a >
2016-07-07 11:41:32 +03:00
< / li >
< li >
2019-07-15 22:12:34 +03:00
< a href = "../responses/" > Responses< / a >
2016-07-07 11:41:32 +03:00
< / li >
< li >
2019-07-15 22:12:34 +03:00
< a href = "../views/" > Views< / a >
2016-07-07 11:41:32 +03:00
< / li >
< li >
2019-07-15 22:12:34 +03:00
< a href = "../generic-views/" > Generic views< / a >
2016-07-07 11:41:32 +03:00
< / li >
< li >
2019-07-15 22:12:34 +03:00
< a href = "../viewsets/" > Viewsets< / a >
2016-07-07 11:41:32 +03:00
< / li >
< li >
2019-07-15 22:12:34 +03:00
< a href = "../routers/" > Routers< / a >
2016-07-07 11:41:32 +03:00
< / li >
< li >
2019-07-15 22:12:34 +03:00
< a href = "../parsers/" > Parsers< / a >
2016-07-07 11:41:32 +03:00
< / li >
< li >
2019-07-15 22:12:34 +03:00
< a href = "../renderers/" > Renderers< / a >
2016-07-07 11:41:32 +03:00
< / li >
< li >
2019-07-15 22:12:34 +03:00
< a href = "../serializers/" > Serializers< / a >
2016-07-07 11:41:32 +03:00
< / li >
< li >
2019-07-15 22:12:34 +03:00
< a href = "../fields/" > Serializer fields< / a >
2016-07-07 11:41:32 +03:00
< / li >
< li >
2019-07-15 22:12:34 +03:00
< a href = "../relations/" > Serializer relations< / a >
2016-07-07 11:41:32 +03:00
< / li >
< li >
2019-07-15 22:12:34 +03:00
< a href = "../validators/" > Validators< / a >
2016-07-07 11:41:32 +03:00
< / li >
< li >
2019-07-15 22:12:34 +03:00
< a href = "../authentication/" > Authentication< / a >
2016-07-07 11:41:32 +03:00
< / li >
< li >
2019-07-15 22:12:34 +03:00
< a href = "../permissions/" > Permissions< / a >
2016-07-07 11:41:32 +03:00
< / li >
2018-10-11 16:48:33 +03:00
< li >
2019-07-15 22:12:34 +03:00
< a href = "../caching/" > Caching< / a >
2018-10-11 16:48:33 +03:00
< / li >
2016-07-07 11:41:32 +03:00
< li >
2019-07-15 22:12:34 +03:00
< a href = "../throttling/" > Throttling< / a >
2016-07-07 11:41:32 +03:00
< / li >
< li >
2019-07-15 22:12:34 +03:00
< a href = "../filtering/" > Filtering< / a >
2016-07-07 11:41:32 +03:00
< / li >
< li >
2019-07-15 22:12:34 +03:00
< a href = "../pagination/" > Pagination< / a >
2016-07-07 11:41:32 +03:00
< / li >
< li >
2019-07-15 22:12:34 +03:00
< a href = "../versioning/" > Versioning< / a >
2016-07-07 11:41:32 +03:00
< / li >
< li >
2019-07-15 22:12:34 +03:00
< a href = "../content-negotiation/" > Content negotiation< / a >
2016-07-07 11:41:32 +03:00
< / li >
< li >
2019-07-15 22:12:34 +03:00
< a href = "../metadata/" > Metadata< / a >
2016-07-07 11:41:32 +03:00
< / li >
< li class = "active" >
2019-07-15 22:12:34 +03:00
< a href = "./" > Schemas< / a >
2016-07-07 11:41:32 +03:00
< / li >
< li >
2019-07-15 22:12:34 +03:00
< a href = "../format-suffixes/" > Format suffixes< / a >
2016-07-07 11:41:32 +03:00
< / li >
< li >
2019-07-15 22:12:34 +03:00
< a href = "../reverse/" > Returning URLs< / a >
2016-07-07 11:41:32 +03:00
< / li >
< li >
2019-07-15 22:12:34 +03:00
< a href = "../exceptions/" > Exceptions< / a >
2016-07-07 11:41:32 +03:00
< / li >
< li >
2019-07-15 22:12:34 +03:00
< a href = "../status-codes/" > Status codes< / a >
2016-07-07 11:41:32 +03:00
< / li >
< li >
2019-07-15 22:12:34 +03:00
< a href = "../testing/" > Testing< / a >
2016-07-07 11:41:32 +03:00
< / li >
< li >
2019-07-15 22:12:34 +03:00
< a href = "../settings/" > Settings< / a >
2016-07-07 11:41:32 +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 >
2019-07-15 22:12:34 +03:00
< a href = "../../topics/documenting-your-api/" > Documenting your API< / a >
2016-07-07 11:41:32 +03:00
< / li >
< li >
2019-07-15 22:12:34 +03:00
< a href = "../../topics/api-clients/" > API Clients< / a >
2016-07-07 11:41:32 +03:00
< / li >
< li >
2019-07-15 22:12:34 +03:00
< a href = "../../topics/internationalization/" > Internationalization< / a >
2016-07-07 11:41:32 +03:00
< / li >
< li >
2019-07-15 22:12:34 +03:00
< a href = "../../topics/ajax-csrf-cors/" > AJAX, CSRF & CORS< / a >
2016-07-07 11:41:32 +03:00
< / li >
< li >
2019-07-15 22:12:34 +03:00
< a href = "../../topics/html-and-forms/" > HTML & Forms< / a >
2016-07-07 11:41:32 +03:00
< / li >
< li >
2019-07-15 22:12:34 +03:00
< a href = "../../topics/browser-enhancements/" > Browser Enhancements< / a >
2016-07-07 11:41:32 +03:00
< / li >
< li >
2019-07-15 22:12:34 +03:00
< a href = "../../topics/browsable-api/" > The Browsable API< / a >
2016-07-07 11:41:32 +03:00
< / li >
< li >
2019-07-15 22:12:34 +03:00
< a href = "../../topics/rest-hypermedia-hateoas/" > REST, Hypermedia & HATEOAS< / a >
2016-07-07 11:41:32 +03:00
< / li >
2018-10-11 16:48:33 +03:00
< / ul >
< / li >
< li class = "dropdown" >
< a href = "#" class = "dropdown-toggle" data-toggle = "dropdown" > Community < b class = "caret" > < / b > < / a >
< ul class = "dropdown-menu" >
2016-07-07 11:41:32 +03:00
< li >
2019-07-15 22:12:34 +03:00
< a href = "../../community/tutorials-and-resources/" > Tutorials and Resources< / a >
2017-02-25 22:59:44 +03:00
< / li >
< li >
2019-07-15 22:12:34 +03:00
< a href = "../../community/third-party-packages/" > Third Party Packages< / a >
2016-07-07 11:41:32 +03:00
< / li >
< li >
2019-07-15 22:12:34 +03:00
< a href = "../../community/contributing/" > Contributing to REST framework< / a >
2016-07-07 11:41:32 +03:00
< / li >
< li >
2019-07-15 22:12:34 +03:00
< a href = "../../community/project-management/" > Project management< / a >
2016-07-07 11:41:32 +03:00
< / li >
2017-03-09 17:59:14 +03:00
< li >
2019-07-15 22:12:34 +03:00
< a href = "../../community/release-notes/" > Release Notes< / a >
2017-03-09 17:59:14 +03:00
< / li >
2019-12-12 17:50:50 +03:00
< li >
< a href = "../../community/3.11-announcement/" > 3.11 Announcement< / a >
< / li >
2018-10-18 13:50:44 +03:00
< li >
2019-07-15 22:12:34 +03:00
< a href = "../../community/3.10-announcement/" > 3.10 Announcement< / a >
2018-10-18 13:50:44 +03:00
< / li >
2016-07-07 11:41:32 +03:00
< li >
2019-07-15 22:12:34 +03:00
< a href = "../../community/3.9-announcement/" > 3.9 Announcement< / a >
2016-07-07 11:41:32 +03:00
< / li >
< li >
2019-07-15 22:12:34 +03:00
< a href = "../../community/3.8-announcement/" > 3.8 Announcement< / a >
2016-07-07 11:41:32 +03:00
< / li >
< li >
2019-07-15 22:12:34 +03:00
< a href = "../../community/3.7-announcement/" > 3.7 Announcement< / a >
2016-07-07 11:41:32 +03:00
< / li >
< li >
2019-07-15 22:12:34 +03:00
< a href = "../../community/3.6-announcement/" > 3.6 Announcement< / a >
2016-07-07 11:41:32 +03:00
< / li >
2016-07-14 15:05:57 +03:00
< li >
2019-07-15 22:12:34 +03:00
< a href = "../../community/3.5-announcement/" > 3.5 Announcement< / a >
2016-07-14 15:05:57 +03:00
< / li >
2016-10-20 18:31:37 +03:00
< li >
2019-07-15 22:12:34 +03:00
< a href = "../../community/3.4-announcement/" > 3.4 Announcement< / a >
2016-10-20 18:31:37 +03:00
< / li >
2017-03-09 17:59:14 +03:00
< li >
2019-07-15 22:12:34 +03:00
< a href = "../../community/3.3-announcement/" > 3.3 Announcement< / a >
2017-03-09 17:59:14 +03:00
< / li >
2017-10-06 15:06:25 +03:00
< li >
2019-07-15 22:12:34 +03:00
< a href = "../../community/3.2-announcement/" > 3.2 Announcement< / a >
2017-10-06 15:06:25 +03:00
< / li >
2018-04-03 16:54:40 +03:00
< li >
2019-07-15 22:12:34 +03:00
< a href = "../../community/3.1-announcement/" > 3.1 Announcement< / a >
2018-04-03 16:54:40 +03:00
< / li >
2016-07-07 11:41:32 +03:00
< li >
2019-07-15 22:12:34 +03:00
< a href = "../../community/3.0-announcement/" > 3.0 Announcement< / a >
2016-07-07 11:41:32 +03:00
< / li >
< li >
2019-07-15 22:12:34 +03:00
< a href = "../../community/kickstarter-announcement/" > Kickstarter Announcement< / a >
2016-07-07 11:41:32 +03:00
< / li >
< li >
2019-07-15 22:12:34 +03:00
< a href = "../../community/mozilla-grant/" > Mozilla Grant< / a >
2016-07-07 11:41:32 +03:00
< / li >
< li >
2019-07-15 22:12:34 +03:00
< a href = "../../community/funding/" > Funding< / a >
2019-07-15 14:38:39 +03:00
< / li >
< li >
2019-07-15 22:12:34 +03:00
< a href = "../../community/jobs/" > Jobs< / a >
2016-07-07 11:41:32 +03:00
< / li >
< / ul >
< / li >
< / ul >
< / div >
<!-- /.nav - collapse -->
< / div >
< / div >
< / div >
< div class = "body-content" >
< div class = "container-fluid" >
<!-- Search Modal -->
< div id = "mkdocs_search_modal" 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" >
< form role = "form" autocomplete = "off" >
< div class = "form-group" >
< input type = "text" name = "q" class = "form-control" placeholder = "Search..." id = "mkdocs-search-query" >
< / div >
< / form >
< div id = "mkdocs-search-results" > < / div >
< / 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" >
< div id = "table-of-contents" >
< ul class = "nav nav-list side-nav well sidebar-nav-fixed" >
< li class = "main" >
2019-07-16 11:19:30 +03:00
< a href = "#schema" > Schema< / a >
2016-07-14 15:05:57 +03:00
< / li >
< li >
2019-07-16 11:19:30 +03:00
< a href = "#generating-an-openapi-schema" > Generating an OpenAPI Schema< / a >
2016-07-07 11:41:32 +03:00
< / li >
< li >
2019-07-16 11:19:30 +03:00
< a href = "#customizing-schema-generation" > Customizing Schema Generation< / a >
2018-01-15 17:42:44 +03:00
< / li >
2017-10-06 15:06:25 +03:00
2016-07-07 11:41:32 +03:00
< div class = "promo" >
< hr / >
< div id = "sidebarInclude" >
< / div >
< / ul >
< / div >
< / div >
< div id = "main-content" class = "span9" >
2019-10-07 16:26:05 +03:00
< a class = "github" href = "https://github.com/encode/django-rest-framework/tree/master/rest_framework/schemas" >
< span class = "label label-info" > schemas< / span >
2016-07-07 11:41:32 +03:00
< / a >
2019-07-15 14:38:39 +03:00
< h1 id = "schema" > < a class = "toclink" href = "#schema" > Schema< / a > < / h1 >
2016-07-07 11:41:32 +03:00
< blockquote >
< p > A machine-readable [schema] describes what resources are available via the API, what their URLs are, how they are represented and what operations they support.< / p >
2019-07-15 14:38:39 +03:00
< p > — Heroku, [JSON Schema for the Heroku Platform API][cite]< / p >
2016-07-07 11:41:32 +03:00
< / blockquote >
< p > API schemas are a useful tool that allow for a range of use cases, including
generating reference documentation, or driving dynamic client libraries that
can interact with your API.< / p >
2019-07-15 14:38:39 +03:00
< p > Django REST Framework provides support for automatic generation of
< a href = "https://github.com/OAI/OpenAPI-Specification" > OpenAPI< / a > schemas.< / p >
< h2 id = "generating-an-openapi-schema" > < a class = "toclink" href = "#generating-an-openapi-schema" > Generating an OpenAPI Schema< / a > < / h2 >
< h3 id = "install-pyyaml" > < a class = "toclink" href = "#install-pyyaml" > Install < code > pyyaml< / code > < / a > < / h3 >
< p > You'll need to install < code > pyyaml< / code > , so that you can render your generated schema
into the commonly used YAML-based OpenAPI format.< / p >
< pre > < code > pip install pyyaml
2017-10-06 15:06:25 +03:00
< / code > < / pre >
2019-07-15 14:38:39 +03:00
< h3 id = "generating-a-static-schema-with-the-generateschema-management-command" > < a class = "toclink" href = "#generating-a-static-schema-with-the-generateschema-management-command" > Generating a static schema with the < code > generateschema< / code > management command< / a > < / h3 >
< p > If your schema is static, you can use the < code > generateschema< / code > management command:< / p >
< pre > < code class = "bash" > ./manage.py generateschema > openapi-schema.yml
2018-10-11 16:48:33 +03:00
< / code > < / pre >
< p > Once you've generated a schema in this way you can annotate it with any
additional information that cannot be automatically inferred by the schema
generator.< / p >
< p > You might want to check your API schema into version control and update it
with each new release, or serve the API schema from your site's static media.< / p >
2019-07-15 14:38:39 +03:00
< h3 id = "generating-a-dynamic-schema-with-schemaview" > < a class = "toclink" href = "#generating-a-dynamic-schema-with-schemaview" > Generating a dynamic schema with < code > SchemaView< / code > < / a > < / h3 >
< p > If you require a dynamic schema, because foreign key choices depend on database
values, for example, you can route a < code > SchemaView< / code > that will generate and serve
your schema on demand.< / p >
< p > To route a < code > SchemaView< / code > , use the < code > get_schema_view()< / code > helper.< / p >
< p > In < code > urls.py< / code > :< / p >
2019-07-17 17:11:16 +03:00
< pre > < code class = "python" > from rest_framework.schemas import get_schema_view
2018-10-11 16:48:33 +03:00
urlpatterns = [
2019-07-15 14:38:39 +03:00
# ...
# Use the `get_schema_view()` helper to add a `SchemaView` to project URLs.
# * `title` and `description` parameters are passed to `SchemaGenerator`.
# * Provide view name for use with `reverse()`.
path('openapi', get_schema_view(
title=" Your Project" ,
2019-09-04 16:36:05 +03:00
description=" API for all things …" ,
version=" 1.0.0"
2019-07-15 14:38:39 +03:00
), name='openapi-schema'),
# ...
2018-10-11 16:48:33 +03:00
]
< / code > < / pre >
2019-07-15 14:38:39 +03:00
< h4 id = "get_schema_view" > < a class = "toclink" href = "#get_schema_view" > < code > get_schema_view()< / code > < / a > < / h4 >
< p > The < code > get_schema_view()< / code > helper takes the following keyword arguments:< / p >
2017-10-06 15:06:25 +03:00
< ul >
2019-07-15 14:38:39 +03:00
< li > < code > title< / code > : May be used to provide a descriptive title for the schema definition.< / li >
< li > < code > description< / code > : Longer descriptive text.< / li >
2019-12-12 17:50:50 +03:00
< li > < code > version< / code > : The version of the API.< / li >
2017-10-06 15:06:25 +03:00
< li >
2019-07-15 14:38:39 +03:00
< p > < code > url< / code > : May be used to pass a canonical base URL for the schema.< / p >
2016-10-14 16:33:49 +03:00
< pre > < code > schema_view = get_schema_view(
title='Server Monitoring API',
url='https://www.example.org/api/'
)
< / code > < / pre >
2019-07-15 14:38:39 +03:00
< / li >
< li >
< p > < code > urlconf< / code > : A string representing the import path to the URL conf that you want
to generate an API schema for. This defaults to the value of Django's
< code > ROOT_URLCONF< / code > setting.< / p >
2017-01-27 13:36:59 +03:00
< pre > < code > schema_view = get_schema_view(
title='Server Monitoring API',
url='https://www.example.org/api/',
urlconf='myproject.urls'
)
< / code > < / pre >
2019-12-12 17:50:50 +03:00
< / li >
2019-07-15 14:38:39 +03:00
< li >
< p > < code > patterns< / code > : List of url patterns to limit the schema introspection to. If you
only want the < code > myproject.api< / code > urls to be exposed in the schema:< / p >
2019-12-12 17:50:50 +03:00
< pre > < code > schema_url_patterns = [
2017-05-12 19:15:00 +03:00
url(r'^api/', include('myproject.api.urls')),
2019-12-12 17:50:50 +03:00
]
schema_view = get_schema_view(
2017-05-12 19:15:00 +03:00
title='Server Monitoring API',
url='https://www.example.org/api/',
patterns=schema_url_patterns,
2019-12-12 17:50:50 +03:00
)
< / code > < / pre >
2019-07-15 14:38:39 +03:00
< / li >
< li >
< p > < code > generator_class< / code > : May be used to specify a < code > SchemaGenerator< / code > subclass to be
passed to the < code > SchemaView< / code > .< / p >
< / li >
< li > < code > authentication_classes< / code > : May be used to specify the list of authentication
classes that will apply to the schema endpoint. Defaults to
< code > settings.DEFAULT_AUTHENTICATION_CLASSES< / code > < / li >
< li > < code > permission_classes< / code > : May be used to specify the list of permission classes
that will apply to the schema endpoint. Defaults to
< code > settings.DEFAULT_PERMISSION_CLASSES< / code > .< / li >
< li > < code > renderer_classes< / code > : May be used to pass the set of renderer classes that can
be used to render the API root endpoint.< / li >
< / ul >
< h2 id = "customizing-schema-generation" > < a class = "toclink" href = "#customizing-schema-generation" > Customizing Schema Generation< / a > < / h2 >
< p > You may customize schema generation at the level of the schema as a whole, or
on a per-view basis.< / p >
< h3 id = "schema-level-customization" > < a class = "toclink" href = "#schema-level-customization" > Schema Level Customization< / a > < / h3 >
< p > In order to customize the top-level schema sublass
< code > rest_framework.schemas.openapi.SchemaGenerator< / code > and provide it as an argument
to the < code > generateschema< / code > command or < code > get_schema_view()< / code > helper function.< / p >
< h4 id = "schemagenerator" > < a class = "toclink" href = "#schemagenerator" > SchemaGenerator< / a > < / h4 >
< p > A class that walks a list of routed URL patterns, requests the schema for each
view and collates the resulting OpenAPI schema.< / p >
< p > Typically you'll instantiate < code > SchemaGenerator< / code > with a < code > title< / code > argument, like so:< / p >
2016-07-07 11:41:32 +03:00
< pre > < code > generator = SchemaGenerator(title='Stock Prices API')
< / code > < / pre >
< p > Arguments:< / p >
< ul >
2019-07-15 14:38:39 +03:00
< li > < code > title< / code > < strong > required< / strong > : The name of the API.< / li >
< li > < code > description< / code > : Longer descriptive text.< / li >
2019-09-04 16:36:05 +03:00
< li > < code > version< / code > : The version of the API. Defaults to < code > 0.1.0< / code > .< / li >
2019-07-15 14:38:39 +03:00
< li > < code > url< / code > : The root URL of the API schema. This option is not required unless the schema is included under path prefix.< / li >
< li > < code > patterns< / code > : A list of URLs to inspect when generating the schema. Defaults to the project's URL conf.< / li >
< li > < code > urlconf< / code > : A URL conf module name to use when generating the schema. Defaults to < code > settings.ROOT_URLCONF< / code > .< / li >
2016-07-07 11:41:32 +03:00
< / ul >
2019-07-15 14:38:39 +03:00
< h5 id = "get_schemaself-request" > < a class = "toclink" href = "#get_schemaself-request" > get_schema(self, request)< / a > < / h5 >
< p > Returns a dictionary that represents the OpenAPI schema:< / p >
< pre > < code > generator = SchemaGenerator(title='Stock Prices API')
schema = generator.get_schema()
2016-07-07 11:41:32 +03:00
< / code > < / pre >
2019-07-15 14:38:39 +03:00
< p > The < code > request< / code > argument is optional, and may be used if you want to apply
per-user permissions to the resulting schema generation.< / p >
2019-12-12 17:50:50 +03:00
< p > This is a good point to override if you want to customize the generated
2019-07-15 14:38:39 +03:00
dictionary, for example to add custom
< a href = "https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.2.md#specification-extensions" > specification extensions< / a > .< / p >
< h3 id = "per-view-customization" > < a class = "toclink" href = "#per-view-customization" > Per-View Customization< / a > < / h3 >
< p > By default, view introspection is performed by an < code > AutoSchema< / code > instance
accessible via the < code > schema< / code > attribute on < code > APIView< / code > . This provides the
appropriate < a href = "https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.2.md#operationObject" > Open API operation object< / a > for the view,
request method and path:< / p >
< pre > < code > auto_schema = view.schema
operation = auto_schema.get_operation(...)
2017-10-06 15:06:25 +03:00
< / code > < / pre >
2019-07-15 14:38:39 +03:00
< p > In compiling the schema, < code > SchemaGenerator< / code > calls < code > view.schema.get_operation()< / code >
for each view, allowed method, and path.< / p >
< hr / >
< p > < strong > Note< / strong > : For basic < code > APIView< / code > subclasses, default introspection is essentially
limited to the URL kwarg path parameters. For < code > GenericAPIView< / code >
subclasses, which includes all the provided class based views, < code > AutoSchema< / code > will
2019-12-12 17:50:50 +03:00
attempt to introspect serializer, pagination and filter fields, as well as
2019-07-15 14:38:39 +03:00
provide richer path field descriptions. (The key hooks here are the relevant
< code > GenericAPIView< / code > attributes and methods: < code > get_serializer< / code > , < code > pagination_class< / code > ,
< code > filter_backends< / code > and so on.)< / p >
< hr / >
2019-12-12 17:50:50 +03:00
< p > In order to customize the operation generation, you should provide an < code > AutoSchema< / code > subclass, overriding < code > get_operation()< / code > as you need:< / p >
2019-07-15 14:38:39 +03:00
< pre > < code > from rest_framework.views import APIView
from rest_framework.schemas.openapi import AutoSchema
2017-10-06 15:06:25 +03:00
2019-07-15 14:38:39 +03:00
class CustomSchema(AutoSchema):
2019-12-12 17:50:50 +03:00
def get_operation(...):
2019-07-15 14:38:39 +03:00
# Implement custom introspection here (or in other sub-methods)
2017-10-06 15:06:25 +03:00
2019-07-15 14:38:39 +03:00
class CustomView(APIView):
"""APIView subclass with custom schema introspection."""
schema = CustomSchema()
2017-10-06 15:06:25 +03:00
< / code > < / pre >
2019-07-15 14:38:39 +03:00
< p > This provides complete control over view introspection.< / p >
< p > You may disable schema generation for a view by setting < code > schema< / code > to < code > None< / code > :< / p >
< pre > < code > class CustomView(APIView):
...
schema = None # Will not appear in schema
2017-12-20 17:34:31 +03:00
< / code > < / pre >
2019-07-15 14:38:39 +03:00
< p > This also applies to extra actions for < code > ViewSet< / code > s:< / p >
< pre > < code > class CustomViewSet(viewsets.ModelViewSet):
2017-12-20 17:34:31 +03:00
2019-07-15 14:38:39 +03:00
@action(detail=True, schema=None)
def extra_action(self, request, pk=None):
2016-07-07 11:41:32 +03:00
...
< / code > < / pre >
2019-07-15 14:38:39 +03:00
< p > If you wish to provide a base < code > AutoSchema< / code > subclass to be used throughout your
project you may adjust < code > settings.DEFAULT_SCHEMA_CLASS< / code > appropriately.< / p >
2016-07-07 11:41:32 +03:00
< / 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 > .
< / p >
< / footer >
<!-- Le javascript
================================================== -->
<!-- Placed at the end of the document so the pages load faster -->
2019-07-17 17:11:16 +03:00
< script async src = "https://fund.django-rest-framework.org/sidebar_include.js" > < / script >
2016-07-07 11:41:32 +03:00
< 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 >
2019-07-17 17:11:16 +03:00
< script > var base _url = '../..' ; < / script >
< script src = "../../search/main.js" defer > < / script >
2016-07-07 11:41:32 +03:00
< script >
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/dropdown to no higher than browser window
$('.side-nav, .dropdown-menu').css('max-height', window.innerHeight - 130);
$(function() {
$(window).resize(function() {
$('.side-nav, .dropdown-menu').css('max-height', window.innerHeight - 130);
});
});
< / script >
< / body >
< / html >
