mirror of
https://github.com/encode/django-rest-framework.git
synced 2024-11-29 13:04:03 +03:00
Deployed 4a07d31 with MkDocs version: 0.15.3
This commit is contained in:
Tom Christie
parent
bd895fb63f
commit
848f7597c0
8
404.html
8
404.html
|
|
@ -199,6 +199,10 @@
|
||||||
<a href="api-guide/metadata/">Metadata</a>
|
<a href="api-guide/metadata/">Metadata</a>
|
||||||
</li>
|
</li>
|
||||||
|
|
||||||
|
<li >
|
||||||
|
<a href="api-guide/schemas/">Schemas</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
<li >
|
<li >
|
||||||
<a href="api-guide/format-suffixes/">Format suffixes</a>
|
<a href="api-guide/format-suffixes/">Format suffixes</a>
|
||||||
</li>
|
</li>
|
||||||
|
|
@ -234,6 +238,10 @@
|
||||||
<a href="topics/documenting-your-api/">Documenting your API</a>
|
<a href="topics/documenting-your-api/">Documenting your API</a>
|
||||||
</li>
|
</li>
|
||||||
|
|
||||||
|
<li >
|
||||||
|
<a href="topics/api-clients/">API Clients</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
<li >
|
<li >
|
||||||
<a href="topics/internationalization/">Internationalization</a>
|
<a href="topics/internationalization/">Internationalization</a>
|
||||||
</li>
|
</li>
|
||||||
|
|
|
||||||
|
|
@ -199,6 +199,10 @@
|
||||||
<a href="../metadata/">Metadata</a>
|
<a href="../metadata/">Metadata</a>
|
||||||
</li>
|
</li>
|
||||||
|
|
||||||
|
<li >
|
||||||
|
<a href="../schemas/">Schemas</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
<li >
|
<li >
|
||||||
<a href="../format-suffixes/">Format suffixes</a>
|
<a href="../format-suffixes/">Format suffixes</a>
|
||||||
</li>
|
</li>
|
||||||
|
|
@ -234,6 +238,10 @@
|
||||||
<a href="../../topics/documenting-your-api/">Documenting your API</a>
|
<a href="../../topics/documenting-your-api/">Documenting your API</a>
|
||||||
</li>
|
</li>
|
||||||
|
|
||||||
|
<li >
|
||||||
|
<a href="../../topics/api-clients/">API Clients</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
<li >
|
<li >
|
||||||
<a href="../../topics/internationalization/">Internationalization</a>
|
<a href="../../topics/internationalization/">Internationalization</a>
|
||||||
</li>
|
</li>
|
||||||
|
|
|
||||||
|
|
@ -199,6 +199,10 @@
|
||||||
<a href="../metadata/">Metadata</a>
|
<a href="../metadata/">Metadata</a>
|
||||||
</li>
|
</li>
|
||||||
|
|
||||||
|
<li >
|
||||||
|
<a href="../schemas/">Schemas</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
<li >
|
<li >
|
||||||
<a href="../format-suffixes/">Format suffixes</a>
|
<a href="../format-suffixes/">Format suffixes</a>
|
||||||
</li>
|
</li>
|
||||||
|
|
@ -234,6 +238,10 @@
|
||||||
<a href="../../topics/documenting-your-api/">Documenting your API</a>
|
<a href="../../topics/documenting-your-api/">Documenting your API</a>
|
||||||
</li>
|
</li>
|
||||||
|
|
||||||
|
<li >
|
||||||
|
<a href="../../topics/api-clients/">API Clients</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
<li >
|
<li >
|
||||||
<a href="../../topics/internationalization/">Internationalization</a>
|
<a href="../../topics/internationalization/">Internationalization</a>
|
||||||
</li>
|
</li>
|
||||||
|
|
|
||||||
|
|
@ -199,6 +199,10 @@
|
||||||
<a href="../metadata/">Metadata</a>
|
<a href="../metadata/">Metadata</a>
|
||||||
</li>
|
</li>
|
||||||
|
|
||||||
|
<li >
|
||||||
|
<a href="../schemas/">Schemas</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
<li >
|
<li >
|
||||||
<a href="../format-suffixes/">Format suffixes</a>
|
<a href="../format-suffixes/">Format suffixes</a>
|
||||||
</li>
|
</li>
|
||||||
|
|
@ -234,6 +238,10 @@
|
||||||
<a href="../../topics/documenting-your-api/">Documenting your API</a>
|
<a href="../../topics/documenting-your-api/">Documenting your API</a>
|
||||||
</li>
|
</li>
|
||||||
|
|
||||||
|
<li >
|
||||||
|
<a href="../../topics/api-clients/">API Clients</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
<li >
|
<li >
|
||||||
<a href="../../topics/internationalization/">Internationalization</a>
|
<a href="../../topics/internationalization/">Internationalization</a>
|
||||||
</li>
|
</li>
|
||||||
|
|
|
||||||
|
|
@ -199,6 +199,10 @@
|
||||||
<a href="../metadata/">Metadata</a>
|
<a href="../metadata/">Metadata</a>
|
||||||
</li>
|
</li>
|
||||||
|
|
||||||
|
<li >
|
||||||
|
<a href="../schemas/">Schemas</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
<li >
|
<li >
|
||||||
<a href="../format-suffixes/">Format suffixes</a>
|
<a href="../format-suffixes/">Format suffixes</a>
|
||||||
</li>
|
</li>
|
||||||
|
|
@ -234,6 +238,10 @@
|
||||||
<a href="../../topics/documenting-your-api/">Documenting your API</a>
|
<a href="../../topics/documenting-your-api/">Documenting your API</a>
|
||||||
</li>
|
</li>
|
||||||
|
|
||||||
|
<li >
|
||||||
|
<a href="../../topics/api-clients/">API Clients</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
<li >
|
<li >
|
||||||
<a href="../../topics/internationalization/">Internationalization</a>
|
<a href="../../topics/internationalization/">Internationalization</a>
|
||||||
</li>
|
</li>
|
||||||
|
|
@ -741,9 +749,10 @@ color_channel = serializers.ChoiceField(
|
||||||
<ul>
|
<ul>
|
||||||
<li><code>max_digits</code> The maximum number of digits allowed in the number. Note that this number must be greater than or equal to decimal_places.</li>
|
<li><code>max_digits</code> The maximum number of digits allowed in the number. Note that this number must be greater than or equal to decimal_places.</li>
|
||||||
<li><code>decimal_places</code> The number of decimal places to store with the number.</li>
|
<li><code>decimal_places</code> The number of decimal places to store with the number.</li>
|
||||||
<li><code>coerce_to_string</code> Set to <code>True</code> if string values should be returned for the representation, or <code>False</code> if <code>Decimal</code> objects should be returned. Defaults to the same value as the <code>COERCE_DECIMAL_TO_STRING</code> settings key, which will be <code>True</code> unless overridden. If <code>Decimal</code> objects are returned by the serializer, then the final output format will be determined by the renderer.</li>
|
<li><code>coerce_to_string</code> Set to <code>True</code> if string values should be returned for the representation, or <code>False</code> if <code>Decimal</code> objects should be returned. Defaults to the same value as the <code>COERCE_DECIMAL_TO_STRING</code> settings key, which will be <code>True</code> unless overridden. If <code>Decimal</code> objects are returned by the serializer, then the final output format will be determined by the renderer. Note that setting <code>localize</code> will force the value to <code>True</code>.</li>
|
||||||
<li><code>max_value</code> Validate that the number provided is no greater than this value.</li>
|
<li><code>max_value</code> Validate that the number provided is no greater than this value.</li>
|
||||||
<li><code>min_value</code> Validate that the number provided is no less than this value.</li>
|
<li><code>min_value</code> Validate that the number provided is no less than this value.</li>
|
||||||
|
<li><code>localize</code> Set to <code>True</code> to enable localization of input and output based on the current locale. This will also force <code>coerce_to_string</code> to <code>True</code>. Defaults to <code>False</code>. Note that data formatting is enabled if you have set <code>USE_L10N=True</code> in your settings file.</li>
|
||||||
</ul>
|
</ul>
|
||||||
<h4 id="example-usage"><a class="toclink" href="#example-usage">Example usage</a></h4>
|
<h4 id="example-usage"><a class="toclink" href="#example-usage">Example usage</a></h4>
|
||||||
<p>To validate numbers up to 999 with a resolution of 2 decimal places, you would use:</p>
|
<p>To validate numbers up to 999 with a resolution of 2 decimal places, you would use:</p>
|
||||||
|
|
|
||||||
|
|
@ -199,6 +199,10 @@
|
||||||
<a href="../metadata/">Metadata</a>
|
<a href="../metadata/">Metadata</a>
|
||||||
</li>
|
</li>
|
||||||
|
|
||||||
|
<li >
|
||||||
|
<a href="../schemas/">Schemas</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
<li >
|
<li >
|
||||||
<a href="../format-suffixes/">Format suffixes</a>
|
<a href="../format-suffixes/">Format suffixes</a>
|
||||||
</li>
|
</li>
|
||||||
|
|
@ -234,6 +238,10 @@
|
||||||
<a href="../../topics/documenting-your-api/">Documenting your API</a>
|
<a href="../../topics/documenting-your-api/">Documenting your API</a>
|
||||||
</li>
|
</li>
|
||||||
|
|
||||||
|
<li >
|
||||||
|
<a href="../../topics/api-clients/">API Clients</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
<li >
|
<li >
|
||||||
<a href="../../topics/internationalization/">Internationalization</a>
|
<a href="../../topics/internationalization/">Internationalization</a>
|
||||||
</li>
|
</li>
|
||||||
|
|
|
||||||
|
|
@ -61,7 +61,7 @@
|
||||||
<a class="repo-link btn btn-inverse btn-small " rel="prev" href="../reverse/">
|
<a class="repo-link btn btn-inverse btn-small " rel="prev" href="../reverse/">
|
||||||
Next <i class="icon-arrow-right icon-white"></i>
|
Next <i class="icon-arrow-right icon-white"></i>
|
||||||
</a>
|
</a>
|
||||||
<a class="repo-link btn btn-inverse btn-small " rel="next" href="../metadata/">
|
<a class="repo-link btn btn-inverse btn-small " rel="next" href="../schemas/">
|
||||||
<i class="icon-arrow-left icon-white"></i> Previous
|
<i class="icon-arrow-left icon-white"></i> Previous
|
||||||
</a>
|
</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 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>
|
||||||
|
|
@ -199,6 +199,10 @@
|
||||||
<a href="../metadata/">Metadata</a>
|
<a href="../metadata/">Metadata</a>
|
||||||
</li>
|
</li>
|
||||||
|
|
||||||
|
<li >
|
||||||
|
<a href="../schemas/">Schemas</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
<li class="active" >
|
<li class="active" >
|
||||||
<a href="./">Format suffixes</a>
|
<a href="./">Format suffixes</a>
|
||||||
</li>
|
</li>
|
||||||
|
|
@ -234,6 +238,10 @@
|
||||||
<a href="../../topics/documenting-your-api/">Documenting your API</a>
|
<a href="../../topics/documenting-your-api/">Documenting your API</a>
|
||||||
</li>
|
</li>
|
||||||
|
|
||||||
|
<li >
|
||||||
|
<a href="../../topics/api-clients/">API Clients</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
<li >
|
<li >
|
||||||
<a href="../../topics/internationalization/">Internationalization</a>
|
<a href="../../topics/internationalization/">Internationalization</a>
|
||||||
</li>
|
</li>
|
||||||
|
|
|
||||||
|
|
@ -199,6 +199,10 @@
|
||||||
<a href="../metadata/">Metadata</a>
|
<a href="../metadata/">Metadata</a>
|
||||||
</li>
|
</li>
|
||||||
|
|
||||||
|
<li >
|
||||||
|
<a href="../schemas/">Schemas</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
<li >
|
<li >
|
||||||
<a href="../format-suffixes/">Format suffixes</a>
|
<a href="../format-suffixes/">Format suffixes</a>
|
||||||
</li>
|
</li>
|
||||||
|
|
@ -234,6 +238,10 @@
|
||||||
<a href="../../topics/documenting-your-api/">Documenting your API</a>
|
<a href="../../topics/documenting-your-api/">Documenting your API</a>
|
||||||
</li>
|
</li>
|
||||||
|
|
||||||
|
<li >
|
||||||
|
<a href="../../topics/api-clients/">API Clients</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
<li >
|
<li >
|
||||||
<a href="../../topics/internationalization/">Internationalization</a>
|
<a href="../../topics/internationalization/">Internationalization</a>
|
||||||
</li>
|
</li>
|
||||||
|
|
|
||||||
|
|
@ -58,7 +58,7 @@
|
||||||
<div class="navbar-inner">
|
<div class="navbar-inner">
|
||||||
<div class="container-fluid">
|
<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>
|
<a class="repo-link btn btn-primary btn-small" href="https://github.com/tomchristie/django-rest-framework/tree/master">GitHub</a>
|
||||||
<a class="repo-link btn btn-inverse btn-small " rel="prev" href="../format-suffixes/">
|
<a class="repo-link btn btn-inverse btn-small " rel="prev" href="../schemas/">
|
||||||
Next <i class="icon-arrow-right icon-white"></i>
|
Next <i class="icon-arrow-right icon-white"></i>
|
||||||
</a>
|
</a>
|
||||||
<a class="repo-link btn btn-inverse btn-small " rel="next" href="../content-negotiation/">
|
<a class="repo-link btn btn-inverse btn-small " rel="next" href="../content-negotiation/">
|
||||||
|
|
@ -199,6 +199,10 @@
|
||||||
<a href="./">Metadata</a>
|
<a href="./">Metadata</a>
|
||||||
</li>
|
</li>
|
||||||
|
|
||||||
|
<li >
|
||||||
|
<a href="../schemas/">Schemas</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
<li >
|
<li >
|
||||||
<a href="../format-suffixes/">Format suffixes</a>
|
<a href="../format-suffixes/">Format suffixes</a>
|
||||||
</li>
|
</li>
|
||||||
|
|
@ -234,6 +238,10 @@
|
||||||
<a href="../../topics/documenting-your-api/">Documenting your API</a>
|
<a href="../../topics/documenting-your-api/">Documenting your API</a>
|
||||||
</li>
|
</li>
|
||||||
|
|
||||||
|
<li >
|
||||||
|
<a href="../../topics/api-clients/">API Clients</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
<li >
|
<li >
|
||||||
<a href="../../topics/internationalization/">Internationalization</a>
|
<a href="../../topics/internationalization/">Internationalization</a>
|
||||||
</li>
|
</li>
|
||||||
|
|
|
||||||
|
|
@ -199,6 +199,10 @@
|
||||||
<a href="../metadata/">Metadata</a>
|
<a href="../metadata/">Metadata</a>
|
||||||
</li>
|
</li>
|
||||||
|
|
||||||
|
<li >
|
||||||
|
<a href="../schemas/">Schemas</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
<li >
|
<li >
|
||||||
<a href="../format-suffixes/">Format suffixes</a>
|
<a href="../format-suffixes/">Format suffixes</a>
|
||||||
</li>
|
</li>
|
||||||
|
|
@ -234,6 +238,10 @@
|
||||||
<a href="../../topics/documenting-your-api/">Documenting your API</a>
|
<a href="../../topics/documenting-your-api/">Documenting your API</a>
|
||||||
</li>
|
</li>
|
||||||
|
|
||||||
|
<li >
|
||||||
|
<a href="../../topics/api-clients/">API Clients</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
<li >
|
<li >
|
||||||
<a href="../../topics/internationalization/">Internationalization</a>
|
<a href="../../topics/internationalization/">Internationalization</a>
|
||||||
</li>
|
</li>
|
||||||
|
|
@ -471,7 +479,7 @@ class StandardResultsSetPagination(PageNumberPagination):
|
||||||
<p>You can then apply your new style to a view using the <code>.pagination_class</code> attribute:</p>
|
<p>You can then apply your new style to a view using the <code>.pagination_class</code> attribute:</p>
|
||||||
<pre><code>class BillingRecordsView(generics.ListAPIView):
|
<pre><code>class BillingRecordsView(generics.ListAPIView):
|
||||||
queryset = Billing.objects.all()
|
queryset = Billing.objects.all()
|
||||||
serializer = BillingRecordsSerializer
|
serializer_class = BillingRecordsSerializer
|
||||||
pagination_class = LargeResultsSetPagination
|
pagination_class = LargeResultsSetPagination
|
||||||
</code></pre>
|
</code></pre>
|
||||||
<p>Or apply the style globally, using the <code>DEFAULT_PAGINATION_CLASS</code> settings key. For example:</p>
|
<p>Or apply the style globally, using the <code>DEFAULT_PAGINATION_CLASS</code> settings key. For example:</p>
|
||||||
|
|
|
||||||
|
|
@ -199,6 +199,10 @@
|
||||||
<a href="../metadata/">Metadata</a>
|
<a href="../metadata/">Metadata</a>
|
||||||
</li>
|
</li>
|
||||||
|
|
||||||
|
<li >
|
||||||
|
<a href="../schemas/">Schemas</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
<li >
|
<li >
|
||||||
<a href="../format-suffixes/">Format suffixes</a>
|
<a href="../format-suffixes/">Format suffixes</a>
|
||||||
</li>
|
</li>
|
||||||
|
|
@ -234,6 +238,10 @@
|
||||||
<a href="../../topics/documenting-your-api/">Documenting your API</a>
|
<a href="../../topics/documenting-your-api/">Documenting your API</a>
|
||||||
</li>
|
</li>
|
||||||
|
|
||||||
|
<li >
|
||||||
|
<a href="../../topics/api-clients/">API Clients</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
<li >
|
<li >
|
||||||
<a href="../../topics/internationalization/">Internationalization</a>
|
<a href="../../topics/internationalization/">Internationalization</a>
|
||||||
</li>
|
</li>
|
||||||
|
|
|
||||||
|
|
@ -199,6 +199,10 @@
|
||||||
<a href="../metadata/">Metadata</a>
|
<a href="../metadata/">Metadata</a>
|
||||||
</li>
|
</li>
|
||||||
|
|
||||||
|
<li >
|
||||||
|
<a href="../schemas/">Schemas</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
<li >
|
<li >
|
||||||
<a href="../format-suffixes/">Format suffixes</a>
|
<a href="../format-suffixes/">Format suffixes</a>
|
||||||
</li>
|
</li>
|
||||||
|
|
@ -234,6 +238,10 @@
|
||||||
<a href="../../topics/documenting-your-api/">Documenting your API</a>
|
<a href="../../topics/documenting-your-api/">Documenting your API</a>
|
||||||
</li>
|
</li>
|
||||||
|
|
||||||
|
<li >
|
||||||
|
<a href="../../topics/api-clients/">API Clients</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
<li >
|
<li >
|
||||||
<a href="../../topics/internationalization/">Internationalization</a>
|
<a href="../../topics/internationalization/">Internationalization</a>
|
||||||
</li>
|
</li>
|
||||||
|
|
|
||||||
|
|
@ -199,6 +199,10 @@
|
||||||
<a href="../metadata/">Metadata</a>
|
<a href="../metadata/">Metadata</a>
|
||||||
</li>
|
</li>
|
||||||
|
|
||||||
|
<li >
|
||||||
|
<a href="../schemas/">Schemas</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
<li >
|
<li >
|
||||||
<a href="../format-suffixes/">Format suffixes</a>
|
<a href="../format-suffixes/">Format suffixes</a>
|
||||||
</li>
|
</li>
|
||||||
|
|
@ -234,6 +238,10 @@
|
||||||
<a href="../../topics/documenting-your-api/">Documenting your API</a>
|
<a href="../../topics/documenting-your-api/">Documenting your API</a>
|
||||||
</li>
|
</li>
|
||||||
|
|
||||||
|
<li >
|
||||||
|
<a href="../../topics/api-clients/">API Clients</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
<li >
|
<li >
|
||||||
<a href="../../topics/internationalization/">Internationalization</a>
|
<a href="../../topics/internationalization/">Internationalization</a>
|
||||||
</li>
|
</li>
|
||||||
|
|
|
||||||
|
|
@ -199,6 +199,10 @@
|
||||||
<a href="../metadata/">Metadata</a>
|
<a href="../metadata/">Metadata</a>
|
||||||
</li>
|
</li>
|
||||||
|
|
||||||
|
<li >
|
||||||
|
<a href="../schemas/">Schemas</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
<li >
|
<li >
|
||||||
<a href="../format-suffixes/">Format suffixes</a>
|
<a href="../format-suffixes/">Format suffixes</a>
|
||||||
</li>
|
</li>
|
||||||
|
|
@ -234,6 +238,10 @@
|
||||||
<a href="../../topics/documenting-your-api/">Documenting your API</a>
|
<a href="../../topics/documenting-your-api/">Documenting your API</a>
|
||||||
</li>
|
</li>
|
||||||
|
|
||||||
|
<li >
|
||||||
|
<a href="../../topics/api-clients/">API Clients</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
<li >
|
<li >
|
||||||
<a href="../../topics/internationalization/">Internationalization</a>
|
<a href="../../topics/internationalization/">Internationalization</a>
|
||||||
</li>
|
</li>
|
||||||
|
|
|
||||||
|
|
@ -199,6 +199,10 @@
|
||||||
<a href="../metadata/">Metadata</a>
|
<a href="../metadata/">Metadata</a>
|
||||||
</li>
|
</li>
|
||||||
|
|
||||||
|
<li >
|
||||||
|
<a href="../schemas/">Schemas</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
<li >
|
<li >
|
||||||
<a href="../format-suffixes/">Format suffixes</a>
|
<a href="../format-suffixes/">Format suffixes</a>
|
||||||
</li>
|
</li>
|
||||||
|
|
@ -234,6 +238,10 @@
|
||||||
<a href="../../topics/documenting-your-api/">Documenting your API</a>
|
<a href="../../topics/documenting-your-api/">Documenting your API</a>
|
||||||
</li>
|
</li>
|
||||||
|
|
||||||
|
<li >
|
||||||
|
<a href="../../topics/api-clients/">API Clients</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
<li >
|
<li >
|
||||||
<a href="../../topics/internationalization/">Internationalization</a>
|
<a href="../../topics/internationalization/">Internationalization</a>
|
||||||
</li>
|
</li>
|
||||||
|
|
|
||||||
|
|
@ -199,6 +199,10 @@
|
||||||
<a href="../metadata/">Metadata</a>
|
<a href="../metadata/">Metadata</a>
|
||||||
</li>
|
</li>
|
||||||
|
|
||||||
|
<li >
|
||||||
|
<a href="../schemas/">Schemas</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
<li >
|
<li >
|
||||||
<a href="../format-suffixes/">Format suffixes</a>
|
<a href="../format-suffixes/">Format suffixes</a>
|
||||||
</li>
|
</li>
|
||||||
|
|
@ -234,6 +238,10 @@
|
||||||
<a href="../../topics/documenting-your-api/">Documenting your API</a>
|
<a href="../../topics/documenting-your-api/">Documenting your API</a>
|
||||||
</li>
|
</li>
|
||||||
|
|
||||||
|
<li >
|
||||||
|
<a href="../../topics/api-clients/">API Clients</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
<li >
|
<li >
|
||||||
<a href="../../topics/internationalization/">Internationalization</a>
|
<a href="../../topics/internationalization/">Internationalization</a>
|
||||||
</li>
|
</li>
|
||||||
|
|
|
||||||
|
|
@ -199,6 +199,10 @@
|
||||||
<a href="../metadata/">Metadata</a>
|
<a href="../metadata/">Metadata</a>
|
||||||
</li>
|
</li>
|
||||||
|
|
||||||
|
<li >
|
||||||
|
<a href="../schemas/">Schemas</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
<li >
|
<li >
|
||||||
<a href="../format-suffixes/">Format suffixes</a>
|
<a href="../format-suffixes/">Format suffixes</a>
|
||||||
</li>
|
</li>
|
||||||
|
|
@ -234,6 +238,10 @@
|
||||||
<a href="../../topics/documenting-your-api/">Documenting your API</a>
|
<a href="../../topics/documenting-your-api/">Documenting your API</a>
|
||||||
</li>
|
</li>
|
||||||
|
|
||||||
|
<li >
|
||||||
|
<a href="../../topics/api-clients/">API Clients</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
<li >
|
<li >
|
||||||
<a href="../../topics/internationalization/">Internationalization</a>
|
<a href="../../topics/internationalization/">Internationalization</a>
|
||||||
</li>
|
</li>
|
||||||
|
|
|
||||||
|
|
@ -199,6 +199,10 @@
|
||||||
<a href="../metadata/">Metadata</a>
|
<a href="../metadata/">Metadata</a>
|
||||||
</li>
|
</li>
|
||||||
|
|
||||||
|
<li >
|
||||||
|
<a href="../schemas/">Schemas</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
<li >
|
<li >
|
||||||
<a href="../format-suffixes/">Format suffixes</a>
|
<a href="../format-suffixes/">Format suffixes</a>
|
||||||
</li>
|
</li>
|
||||||
|
|
@ -234,6 +238,10 @@
|
||||||
<a href="../../topics/documenting-your-api/">Documenting your API</a>
|
<a href="../../topics/documenting-your-api/">Documenting your API</a>
|
||||||
</li>
|
</li>
|
||||||
|
|
||||||
|
<li >
|
||||||
|
<a href="../../topics/api-clients/">API Clients</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
<li >
|
<li >
|
||||||
<a href="../../topics/internationalization/">Internationalization</a>
|
<a href="../../topics/internationalization/">Internationalization</a>
|
||||||
</li>
|
</li>
|
||||||
|
|
|
||||||
754
api-guide/schemas/index.html
Normal file
754
api-guide/schemas/index.html
Normal file
|
|
@ -0,0 +1,754 @@
|
||||||
|
<!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">
|
||||||
|
<link rel="canonical" href="http://www.django-rest-framework.org/api-guide/schemas/" />
|
||||||
|
<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">
|
||||||
|
<a class="repo-link btn btn-primary btn-small" href="https://github.com/tomchristie/django-rest-framework/tree/master">GitHub</a>
|
||||||
|
<a class="repo-link btn btn-inverse btn-small " rel="prev" href="../format-suffixes/">
|
||||||
|
Next <i class="icon-arrow-right icon-white"></i>
|
||||||
|
</a>
|
||||||
|
<a class="repo-link btn btn-inverse btn-small " rel="next" href="../metadata/">
|
||||||
|
<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>
|
||||||
|
<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>
|
||||||
|
|
||||||
|
<li class="dropdown">
|
||||||
|
<a href="#" class="dropdown-toggle" data-toggle="dropdown">Tutorial <b class="caret"></b></a>
|
||||||
|
<ul class="dropdown-menu">
|
||||||
|
|
||||||
|
<li >
|
||||||
|
<a href="../../tutorial/quickstart/">Quickstart</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li >
|
||||||
|
<a href="../../tutorial/1-serialization/">1 - Serialization</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li >
|
||||||
|
<a href="../../tutorial/2-requests-and-responses/">2 - Requests and responses</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li >
|
||||||
|
<a href="../../tutorial/3-class-based-views/">3 - Class based views</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li >
|
||||||
|
<a href="../../tutorial/4-authentication-and-permissions/">4 - Authentication and permissions</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li >
|
||||||
|
<a href="../../tutorial/5-relationships-and-hyperlinked-apis/">5 - Relationships and hyperlinked APIs</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li >
|
||||||
|
<a href="../../tutorial/6-viewsets-and-routers/">6 - Viewsets and routers</a>
|
||||||
|
</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 >
|
||||||
|
<a href="../requests/">Requests</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li >
|
||||||
|
<a href="../responses/">Responses</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li >
|
||||||
|
<a href="../views/">Views</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li >
|
||||||
|
<a href="../generic-views/">Generic views</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li >
|
||||||
|
<a href="../viewsets/">Viewsets</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li >
|
||||||
|
<a href="../routers/">Routers</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li >
|
||||||
|
<a href="../parsers/">Parsers</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li >
|
||||||
|
<a href="../renderers/">Renderers</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li >
|
||||||
|
<a href="../serializers/">Serializers</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li >
|
||||||
|
<a href="../fields/">Serializer fields</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li >
|
||||||
|
<a href="../relations/">Serializer relations</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li >
|
||||||
|
<a href="../validators/">Validators</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li >
|
||||||
|
<a href="../authentication/">Authentication</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li >
|
||||||
|
<a href="../permissions/">Permissions</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li >
|
||||||
|
<a href="../throttling/">Throttling</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li >
|
||||||
|
<a href="../filtering/">Filtering</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li >
|
||||||
|
<a href="../pagination/">Pagination</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li >
|
||||||
|
<a href="../versioning/">Versioning</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li >
|
||||||
|
<a href="../content-negotiation/">Content negotiation</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li >
|
||||||
|
<a href="../metadata/">Metadata</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li class="active" >
|
||||||
|
<a href="./">Schemas</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li >
|
||||||
|
<a href="../format-suffixes/">Format suffixes</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li >
|
||||||
|
<a href="../reverse/">Returning URLs</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li >
|
||||||
|
<a href="../exceptions/">Exceptions</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li >
|
||||||
|
<a href="../status-codes/">Status codes</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li >
|
||||||
|
<a href="../testing/">Testing</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li >
|
||||||
|
<a href="../settings/">Settings</a>
|
||||||
|
</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 >
|
||||||
|
<a href="../../topics/documenting-your-api/">Documenting your API</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li >
|
||||||
|
<a href="../../topics/api-clients/">API Clients</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li >
|
||||||
|
<a href="../../topics/internationalization/">Internationalization</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li >
|
||||||
|
<a href="../../topics/ajax-csrf-cors/">AJAX, CSRF & CORS</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li >
|
||||||
|
<a href="../../topics/html-and-forms/">HTML & Forms</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li >
|
||||||
|
<a href="../../topics/browser-enhancements/">Browser Enhancements</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li >
|
||||||
|
<a href="../../topics/browsable-api/">The Browsable API</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li >
|
||||||
|
<a href="../../topics/rest-hypermedia-hateoas/">REST, Hypermedia & HATEOAS</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li >
|
||||||
|
<a href="../../topics/third-party-resources/">Third Party Resources</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li >
|
||||||
|
<a href="../../topics/contributing/">Contributing to REST framework</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li >
|
||||||
|
<a href="../../topics/project-management/">Project management</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li >
|
||||||
|
<a href="../../topics/3.0-announcement/">3.0 Announcement</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li >
|
||||||
|
<a href="../../topics/3.1-announcement/">3.1 Announcement</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li >
|
||||||
|
<a href="../../topics/3.2-announcement/">3.2 Announcement</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li >
|
||||||
|
<a href="../../topics/3.3-announcement/">3.3 Announcement</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li >
|
||||||
|
<a href="../../topics/kickstarter-announcement/">Kickstarter Announcement</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li >
|
||||||
|
<a href="../../topics/mozilla-grant/">Mozilla Grant</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li >
|
||||||
|
<a href="../../topics/funding/">Funding</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li >
|
||||||
|
<a href="../../topics/release-notes/">Release Notes</a>
|
||||||
|
</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">
|
||||||
|
<a href="#schemas">Schemas</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
|
|
||||||
|
<li>
|
||||||
|
<a href="#representing-schemas-internally">Representing schemas internally</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li>
|
||||||
|
<a href="#schema-output-formats">Schema output formats</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li>
|
||||||
|
<a href="#schemas-vs-hypermedia">Schemas vs Hypermedia</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
|
|
||||||
|
<li class="main">
|
||||||
|
<a href="#adding-a-schema">Adding a schema</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
|
|
||||||
|
<li>
|
||||||
|
<a href="#using-defaultrouter">Using DefaultRouter</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li>
|
||||||
|
<a href="#using-schemagenerator">Using SchemaGenerator</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li>
|
||||||
|
<a href="#explicit-schema-definition">Explicit schema definition</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li>
|
||||||
|
<a href="#static-schema-file">Static schema file</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
|
|
||||||
|
<li class="main">
|
||||||
|
<a href="#api-reference">API Reference</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
|
|
||||||
|
<li>
|
||||||
|
<a href="#schemagenerator">SchemaGenerator</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li>
|
||||||
|
<a href="#core-api">Core API</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<div class="promo">
|
||||||
|
<hr/>
|
||||||
|
<div id="sidebarInclude">
|
||||||
|
</div>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
<div id="main-content" class="span9">
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<a class="github" href="https://github.com/tomchristie/django-rest-framework/tree/master/rest_framework/schemas.py">
|
||||||
|
<span class="label label-info">schemas.py</span>
|
||||||
|
</a>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<h1 id="schemas"><a class="toclink" href="#schemas">Schemas</a></h1>
|
||||||
|
<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>
|
||||||
|
<p>— Heroku, <a href="https://blog.heroku.com/archives/2014/1/8/json_schema_for_heroku_platform_api">JSON Schema for the Heroku Platform API</a></p>
|
||||||
|
</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>
|
||||||
|
<h2 id="representing-schemas-internally"><a class="toclink" href="#representing-schemas-internally">Representing schemas internally</a></h2>
|
||||||
|
<p>REST framework uses <a href="http://www.coreapi.org/">Core API</a> in order to model schema information in
|
||||||
|
a format-independent representation. This information can then be rendered
|
||||||
|
into various different schema formats, or used to generate API documentation.</p>
|
||||||
|
<p>When using Core API, a schema is represented as a <code>Document</code> which is the
|
||||||
|
top-level container object for information about the API. Available API
|
||||||
|
interactions are represented using <code>Link</code> objects. Each link includes a URL,
|
||||||
|
HTTP method, and may include a list of <code>Field</code> instances, which describe any
|
||||||
|
parameters that may be accepted by the API endpoint. The <code>Link</code> and <code>Field</code>
|
||||||
|
instances may also include descriptions, that allow an API schema to be
|
||||||
|
rendered into user documentation.</p>
|
||||||
|
<p>Here's an example of an API description that includes a single <code>search</code>
|
||||||
|
endpoint:</p>
|
||||||
|
<pre><code>coreapi.Document(
|
||||||
|
title='Flight Search API',
|
||||||
|
url='https://api.example.org/',
|
||||||
|
content={
|
||||||
|
'search': coreapi.Link(
|
||||||
|
url='/search/',
|
||||||
|
action='get',
|
||||||
|
fields=[
|
||||||
|
coreapi.Field(
|
||||||
|
name='from',
|
||||||
|
required=True,
|
||||||
|
location='query',
|
||||||
|
description='City name or airport code.'
|
||||||
|
),
|
||||||
|
coreapi.Field(
|
||||||
|
name='to',
|
||||||
|
required=True,
|
||||||
|
location='query',
|
||||||
|
description='City name or airport code.'
|
||||||
|
),
|
||||||
|
coreapi.Field(
|
||||||
|
name='date',
|
||||||
|
required=True,
|
||||||
|
location='query',
|
||||||
|
description='Flight date in "YYYY-MM-DD" format.'
|
||||||
|
)
|
||||||
|
],
|
||||||
|
description='Return flight availability and prices.'
|
||||||
|
)
|
||||||
|
}
|
||||||
|
)
|
||||||
|
</code></pre>
|
||||||
|
<h2 id="schema-output-formats"><a class="toclink" href="#schema-output-formats">Schema output formats</a></h2>
|
||||||
|
<p>In order to be presented in an HTTP response, the internal representation
|
||||||
|
has to be rendered into the actual bytes that are used in the response.</p>
|
||||||
|
<p><a href="http://www.coreapi.org/specification/encoding/#core-json-encoding">Core JSON</a> is designed as a canonical format for use with Core API.
|
||||||
|
REST framework includes a renderer class for handling this media type, which
|
||||||
|
is available as <code>renderers.CoreJSONRenderer</code>.</p>
|
||||||
|
<p>Other schema formats such as <a href="https://openapis.org/">Open API</a> (Formerly "Swagger"),
|
||||||
|
<a href="http://json-schema.org/latest/json-schema-hypermedia.html">JSON HyperSchema</a>, or <a href="https://apiblueprint.org/">API Blueprint</a> can
|
||||||
|
also be supported by implementing a custom renderer class.</p>
|
||||||
|
<h2 id="schemas-vs-hypermedia"><a class="toclink" href="#schemas-vs-hypermedia">Schemas vs Hypermedia</a></h2>
|
||||||
|
<p>It's worth pointing out here that Core API can also be used to model hypermedia
|
||||||
|
responses, which present an alternative interaction style to API schemas.</p>
|
||||||
|
<p>With an API schema, the entire available interface is presented up-front
|
||||||
|
as a single endpoint. Responses to individual API endpoints are then typically
|
||||||
|
presented as plain data, without any further interactions contained in each
|
||||||
|
response.</p>
|
||||||
|
<p>With Hypermedia, the client is instead presented with a document containing
|
||||||
|
both data and available interactions. Each interaction results in a new
|
||||||
|
document, detailing both the current state and the available interactions.</p>
|
||||||
|
<p>Further information and support on building Hypermedia APIs with REST framework
|
||||||
|
is planned for a future version.</p>
|
||||||
|
<hr />
|
||||||
|
<h1 id="adding-a-schema"><a class="toclink" href="#adding-a-schema">Adding a schema</a></h1>
|
||||||
|
<p>You'll need to install the <code>coreapi</code> package in order to add schema support
|
||||||
|
for REST framework.</p>
|
||||||
|
<pre><code>pip install coreapi
|
||||||
|
</code></pre>
|
||||||
|
<p>REST framework includes functionality for auto-generating a schema,
|
||||||
|
or allows you to specify one explicitly. There are a few different ways to
|
||||||
|
add a schema to your API, depending on exactly what you need.</p>
|
||||||
|
<h2 id="using-defaultrouter"><a class="toclink" href="#using-defaultrouter">Using DefaultRouter</a></h2>
|
||||||
|
<p>If you're using <code>DefaultRouter</code> then you can include an auto-generated schema,
|
||||||
|
simply by adding a <code>schema_title</code> argument to the router.</p>
|
||||||
|
<pre><code>router = DefaultRouter(schema_title='Server Monitoring API')
|
||||||
|
</code></pre>
|
||||||
|
<p>The schema will be included at the root URL, <code>/</code>, and presented to clients
|
||||||
|
that include the Core JSON media type in their <code>Accept</code> header.</p>
|
||||||
|
<pre><code>$ http http://127.0.0.1:8000/ Accept:application/vnd.coreapi+json
|
||||||
|
HTTP/1.0 200 OK
|
||||||
|
Allow: GET, HEAD, OPTIONS
|
||||||
|
Content-Type: application/vnd.coreapi+json
|
||||||
|
|
||||||
|
{
|
||||||
|
"_meta": {
|
||||||
|
"title": "Server Monitoring API"
|
||||||
|
},
|
||||||
|
"_type": "document",
|
||||||
|
...
|
||||||
|
}
|
||||||
|
</code></pre>
|
||||||
|
<p>This is a great zero-configuration option for when you want to get up and
|
||||||
|
running really quickly. If you want a little more flexibility over the
|
||||||
|
schema output then you'll need to consider using <code>SchemaGenerator</code> instead.</p>
|
||||||
|
<h2 id="using-schemagenerator"><a class="toclink" href="#using-schemagenerator">Using SchemaGenerator</a></h2>
|
||||||
|
<p>The most common way to add a schema to your API is to use the <code>SchemaGenerator</code>
|
||||||
|
class to auto-generate the <code>Document</code> instance, and to return that from a view.</p>
|
||||||
|
<p>This option gives you the flexibility of setting up the schema endpoint
|
||||||
|
with whatever behaviour you want. For example, you can apply different
|
||||||
|
permission, throttling or authentication policies to the schema endpoint.</p>
|
||||||
|
<p>Here's an example of using <code>SchemaGenerator</code> together with a view to
|
||||||
|
return the schema.</p>
|
||||||
|
<p><strong>views.py:</strong></p>
|
||||||
|
<pre><code>from rest_framework.decorators import api_view, renderer_classes
|
||||||
|
from rest_framework import renderers, schemas
|
||||||
|
|
||||||
|
generator = schemas.SchemaGenerator(title='Bookings API')
|
||||||
|
|
||||||
|
@api_view()
|
||||||
|
@renderer_classes([renderers.CoreJSONRenderer])
|
||||||
|
def schema_view(request):
|
||||||
|
return generator.get_schema()
|
||||||
|
</code></pre>
|
||||||
|
<p><strong>urls.py:</strong></p>
|
||||||
|
<pre><code>urlpatterns = [
|
||||||
|
url('/', schema_view),
|
||||||
|
...
|
||||||
|
]
|
||||||
|
</code></pre>
|
||||||
|
<p>You can also serve different schemas to different users, depending on the
|
||||||
|
permissions they have available. This approach can be used to ensure that
|
||||||
|
unauthenticated requests are presented with a different schema to
|
||||||
|
authenticated requests, or to ensure that different parts of the API are
|
||||||
|
made visible to different users depending on their role.</p>
|
||||||
|
<p>In order to present a schema with endpoints filtered by user permissions,
|
||||||
|
you need to pass the <code>request</code> argument to the <code>get_schema()</code> method, like so:</p>
|
||||||
|
<pre><code>@api_view()
|
||||||
|
@renderer_classes([renderers.CoreJSONRenderer])
|
||||||
|
def schema_view(request):
|
||||||
|
return generator.get_schema(request=request)
|
||||||
|
</code></pre>
|
||||||
|
<h2 id="explicit-schema-definition"><a class="toclink" href="#explicit-schema-definition">Explicit schema definition</a></h2>
|
||||||
|
<p>An alternative to the auto-generated approach is to specify the API schema
|
||||||
|
explicitly, by declaring a <code>Document</code> object in your codebase. Doing so is a
|
||||||
|
little more work, but ensures that you have full control over the schema
|
||||||
|
representation.</p>
|
||||||
|
<pre><code>import coreapi
|
||||||
|
from rest_framework.decorators import api_view, renderer_classes
|
||||||
|
from rest_framework import renderers
|
||||||
|
|
||||||
|
schema = coreapi.Document(
|
||||||
|
title='Bookings API',
|
||||||
|
content={
|
||||||
|
...
|
||||||
|
}
|
||||||
|
)
|
||||||
|
|
||||||
|
@api_view()
|
||||||
|
@renderer_classes([renderers.CoreJSONRenderer])
|
||||||
|
def schema_view(request):
|
||||||
|
return schema
|
||||||
|
</code></pre>
|
||||||
|
<h2 id="static-schema-file"><a class="toclink" href="#static-schema-file">Static schema file</a></h2>
|
||||||
|
<p>A final option is to write your API schema as a static file, using one
|
||||||
|
of the available formats, such as Core JSON or Open API.</p>
|
||||||
|
<p>You could then either:</p>
|
||||||
|
<ul>
|
||||||
|
<li>Write a schema definition as a static file, and <a href="https://docs.djangoproject.com/en/dev/howto/static-files/">serve the static file directly</a>.</li>
|
||||||
|
<li>Write a schema definition that is loaded using <code>Core API</code>, and then
|
||||||
|
rendered to one of many available formats, depending on the client request.</li>
|
||||||
|
</ul>
|
||||||
|
<hr />
|
||||||
|
<h1 id="api-reference"><a class="toclink" href="#api-reference">API Reference</a></h1>
|
||||||
|
<h2 id="schemagenerator"><a class="toclink" href="#schemagenerator">SchemaGenerator</a></h2>
|
||||||
|
<p>A class that deals with introspecting your API views, which can be used to
|
||||||
|
generate a schema.</p>
|
||||||
|
<p>Typically you'll instantiate <code>SchemaGenerator</code> with a single argument, like so:</p>
|
||||||
|
<pre><code>generator = SchemaGenerator(title='Stock Prices API')
|
||||||
|
</code></pre>
|
||||||
|
<p>Arguments:</p>
|
||||||
|
<ul>
|
||||||
|
<li><code>title</code> - The name of the API. <strong>required</strong></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>
|
||||||
|
</ul>
|
||||||
|
<h3 id="get_schema"><a class="toclink" href="#get_schema">get_schema()</a></h3>
|
||||||
|
<p>Returns a <code>coreapi.Document</code> instance that represents the API schema.</p>
|
||||||
|
<pre><code>@api_view
|
||||||
|
@renderer_classes([renderers.CoreJSONRenderer])
|
||||||
|
def schema_view(request):
|
||||||
|
return generator.get_schema()
|
||||||
|
</code></pre>
|
||||||
|
<p>Arguments:</p>
|
||||||
|
<ul>
|
||||||
|
<li><code>request</code> - The incoming request. Optionally used if you want to apply per-user permissions to the schema-generation.</li>
|
||||||
|
</ul>
|
||||||
|
<hr />
|
||||||
|
<h2 id="core-api"><a class="toclink" href="#core-api">Core API</a></h2>
|
||||||
|
<p>This documentation gives a brief overview of the components within the <code>coreapi</code>
|
||||||
|
package that are used to represent an API schema.</p>
|
||||||
|
<p>Note that these classes are imported from the <code>coreapi</code> package, rather than
|
||||||
|
from the <code>rest_framework</code> package.</p>
|
||||||
|
<h3 id="document"><a class="toclink" href="#document">Document</a></h3>
|
||||||
|
<p>Represents a container for the API schema.</p>
|
||||||
|
<h4 id="title"><a class="toclink" href="#title"><code>title</code></a></h4>
|
||||||
|
<p>A name for the API.</p>
|
||||||
|
<h4 id="url"><a class="toclink" href="#url"><code>url</code></a></h4>
|
||||||
|
<p>A canonical URL for the API.</p>
|
||||||
|
<h4 id="content"><a class="toclink" href="#content"><code>content</code></a></h4>
|
||||||
|
<p>A dictionary, containing the <code>Link</code> objects that the schema contains.</p>
|
||||||
|
<p>In order to provide more structure to the schema, the <code>content</code> dictionary
|
||||||
|
may be nested, typically to a second level. For example:</p>
|
||||||
|
<pre><code>content={
|
||||||
|
"bookings": {
|
||||||
|
"list": Link(...),
|
||||||
|
"create": Link(...),
|
||||||
|
...
|
||||||
|
},
|
||||||
|
"venues": {
|
||||||
|
"list": Link(...),
|
||||||
|
...
|
||||||
|
},
|
||||||
|
...
|
||||||
|
}
|
||||||
|
</code></pre>
|
||||||
|
<h3 id="link"><a class="toclink" href="#link">Link</a></h3>
|
||||||
|
<p>Represents an individual API endpoint.</p>
|
||||||
|
<h4 id="url_1"><a class="toclink" href="#url_1"><code>url</code></a></h4>
|
||||||
|
<p>The URL of the endpoint. May be a URI template, such as <code>/users/{username}/</code>.</p>
|
||||||
|
<h4 id="action"><a class="toclink" href="#action"><code>action</code></a></h4>
|
||||||
|
<p>The HTTP method associated with the endpoint. Note that URLs that support
|
||||||
|
more than one HTTP method, should correspond to a single <code>Link</code> for each.</p>
|
||||||
|
<h4 id="fields"><a class="toclink" href="#fields"><code>fields</code></a></h4>
|
||||||
|
<p>A list of <code>Field</code> instances, describing the available parameters on the input.</p>
|
||||||
|
<h4 id="description"><a class="toclink" href="#description"><code>description</code></a></h4>
|
||||||
|
<p>A short description of the meaning and intended usage of the endpoint.</p>
|
||||||
|
<h3 id="field"><a class="toclink" href="#field">Field</a></h3>
|
||||||
|
<p>Represents a single input parameter on a given API endpoint.</p>
|
||||||
|
<h4 id="name"><a class="toclink" href="#name"><code>name</code></a></h4>
|
||||||
|
<p>A descriptive name for the input.</p>
|
||||||
|
<h4 id="required"><a class="toclink" href="#required"><code>required</code></a></h4>
|
||||||
|
<p>A boolean, indicated if the client is required to included a value, or if
|
||||||
|
the parameter can be omitted.</p>
|
||||||
|
<h4 id="location"><a class="toclink" href="#location"><code>location</code></a></h4>
|
||||||
|
<p>Determines how the information is encoded into the request. Should be one of
|
||||||
|
the following strings:</p>
|
||||||
|
<p><strong>"path"</strong></p>
|
||||||
|
<p>Included in a templated URI. For example a <code>url</code> value of <code>/products/{product_code}/</code> could be used together with a <code>"path"</code> field, to handle API inputs in a URL path such as <code>/products/slim-fit-jeans/</code>.</p>
|
||||||
|
<p>These fields will normally correspond with <a href="https://docs.djangoproject.com/en/dev/topics/http/urls/#named-groups">named arguments in the project URL conf</a>.</p>
|
||||||
|
<p><strong>"query"</strong></p>
|
||||||
|
<p>Included as a URL query parameter. For example <code>?search=sale</code>. Typically for <code>GET</code> requests.</p>
|
||||||
|
<p>These fields will normally correspond with pagination and filtering controls on a view.</p>
|
||||||
|
<p><strong>"form"</strong></p>
|
||||||
|
<p>Included in the request body, as a single item of a JSON object or HTML form. For example <code>{"colour": "blue", ...}</code>. Typically for <code>POST</code>, <code>PUT</code> and <code>PATCH</code> requests. Multiple <code>"form"</code> fields may be included on a single link.</p>
|
||||||
|
<p>These fields will normally correspond with serializer fields on a view.</p>
|
||||||
|
<p><strong>"body"</strong></p>
|
||||||
|
<p>Included as the complete request body. Typically for <code>POST</code>, <code>PUT</code> and <code>PATCH</code> requests. No more than one <code>"body"</code> field may exist on a link. May not be used together with <code>"form"</code> fields.</p>
|
||||||
|
<p>These fields will normally correspond with views that use <code>ListSerializer</code> to validate the request input, or with file upload views.</p>
|
||||||
|
<h4 id="encoding"><a class="toclink" href="#encoding"><code>encoding</code></a></h4>
|
||||||
|
<p><strong>"application/json"</strong></p>
|
||||||
|
<p>JSON encoded request content. Corresponds to views using <code>JSONParser</code>.
|
||||||
|
Valid only if either one or more <code>location="form"</code> fields, or a single
|
||||||
|
<code>location="body"</code> field is included on the <code>Link</code>.</p>
|
||||||
|
<p><strong>"multipart/form-data"</strong></p>
|
||||||
|
<p>Multipart encoded request content. Corresponds to views using <code>MultiPartParser</code>.
|
||||||
|
Valid only if one or more <code>location="form"</code> fields is included on the <code>Link</code>.</p>
|
||||||
|
<p><strong>"application/x-www-form-urlencoded"</strong></p>
|
||||||
|
<p>URL encoded request content. Corresponds to views using <code>FormParser</code>. Valid
|
||||||
|
only if one or more <code>location="form"</code> fields is included on the <code>Link</code>.</p>
|
||||||
|
<p><strong>"application/octet-stream"</strong></p>
|
||||||
|
<p>Binary upload request content. Corresponds to views using <code>FileUploadParser</code>.
|
||||||
|
Valid only if a <code>location="body"</code> field is included on the <code>Link</code>.</p>
|
||||||
|
<h4 id="description_1"><a class="toclink" href="#description_1"><code>description</code></a></h4>
|
||||||
|
<p>A short description of the meaning and intended usage of the input field.</p>
|
||||||
|
|
||||||
|
|
||||||
|
</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 -->
|
||||||
|
<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="https://fund.django-rest-framework.org/sidebar_include.js"></script>
|
||||||
|
<script>var base_url = '../..';</script>
|
||||||
|
<script src="../../mkdocs/js/require.js"></script>
|
||||||
|
<script src="../../js/theme.js"></script>
|
||||||
|
|
||||||
|
<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>
|
||||||
|
|
@ -199,6 +199,10 @@
|
||||||
<a href="../metadata/">Metadata</a>
|
<a href="../metadata/">Metadata</a>
|
||||||
</li>
|
</li>
|
||||||
|
|
||||||
|
<li >
|
||||||
|
<a href="../schemas/">Schemas</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
<li >
|
<li >
|
||||||
<a href="../format-suffixes/">Format suffixes</a>
|
<a href="../format-suffixes/">Format suffixes</a>
|
||||||
</li>
|
</li>
|
||||||
|
|
@ -234,6 +238,10 @@
|
||||||
<a href="../../topics/documenting-your-api/">Documenting your API</a>
|
<a href="../../topics/documenting-your-api/">Documenting your API</a>
|
||||||
</li>
|
</li>
|
||||||
|
|
||||||
|
<li >
|
||||||
|
<a href="../../topics/api-clients/">API Clients</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
<li >
|
<li >
|
||||||
<a href="../../topics/internationalization/">Internationalization</a>
|
<a href="../../topics/internationalization/">Internationalization</a>
|
||||||
</li>
|
</li>
|
||||||
|
|
|
||||||
|
|
@ -199,6 +199,10 @@
|
||||||
<a href="../metadata/">Metadata</a>
|
<a href="../metadata/">Metadata</a>
|
||||||
</li>
|
</li>
|
||||||
|
|
||||||
|
<li >
|
||||||
|
<a href="../schemas/">Schemas</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
<li >
|
<li >
|
||||||
<a href="../format-suffixes/">Format suffixes</a>
|
<a href="../format-suffixes/">Format suffixes</a>
|
||||||
</li>
|
</li>
|
||||||
|
|
@ -234,6 +238,10 @@
|
||||||
<a href="../../topics/documenting-your-api/">Documenting your API</a>
|
<a href="../../topics/documenting-your-api/">Documenting your API</a>
|
||||||
</li>
|
</li>
|
||||||
|
|
||||||
|
<li >
|
||||||
|
<a href="../../topics/api-clients/">API Clients</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
<li >
|
<li >
|
||||||
<a href="../../topics/internationalization/">Internationalization</a>
|
<a href="../../topics/internationalization/">Internationalization</a>
|
||||||
</li>
|
</li>
|
||||||
|
|
|
||||||
|
|
@ -199,6 +199,10 @@
|
||||||
<a href="../metadata/">Metadata</a>
|
<a href="../metadata/">Metadata</a>
|
||||||
</li>
|
</li>
|
||||||
|
|
||||||
|
<li >
|
||||||
|
<a href="../schemas/">Schemas</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
<li >
|
<li >
|
||||||
<a href="../format-suffixes/">Format suffixes</a>
|
<a href="../format-suffixes/">Format suffixes</a>
|
||||||
</li>
|
</li>
|
||||||
|
|
@ -234,6 +238,10 @@
|
||||||
<a href="../../topics/documenting-your-api/">Documenting your API</a>
|
<a href="../../topics/documenting-your-api/">Documenting your API</a>
|
||||||
</li>
|
</li>
|
||||||
|
|
||||||
|
<li >
|
||||||
|
<a href="../../topics/api-clients/">API Clients</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
<li >
|
<li >
|
||||||
<a href="../../topics/internationalization/">Internationalization</a>
|
<a href="../../topics/internationalization/">Internationalization</a>
|
||||||
</li>
|
</li>
|
||||||
|
|
|
||||||
|
|
@ -199,6 +199,10 @@
|
||||||
<a href="../metadata/">Metadata</a>
|
<a href="../metadata/">Metadata</a>
|
||||||
</li>
|
</li>
|
||||||
|
|
||||||
|
<li >
|
||||||
|
<a href="../schemas/">Schemas</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
<li >
|
<li >
|
||||||
<a href="../format-suffixes/">Format suffixes</a>
|
<a href="../format-suffixes/">Format suffixes</a>
|
||||||
</li>
|
</li>
|
||||||
|
|
@ -234,6 +238,10 @@
|
||||||
<a href="../../topics/documenting-your-api/">Documenting your API</a>
|
<a href="../../topics/documenting-your-api/">Documenting your API</a>
|
||||||
</li>
|
</li>
|
||||||
|
|
||||||
|
<li >
|
||||||
|
<a href="../../topics/api-clients/">API Clients</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
<li >
|
<li >
|
||||||
<a href="../../topics/internationalization/">Internationalization</a>
|
<a href="../../topics/internationalization/">Internationalization</a>
|
||||||
</li>
|
</li>
|
||||||
|
|
|
||||||
|
|
@ -199,6 +199,10 @@
|
||||||
<a href="../metadata/">Metadata</a>
|
<a href="../metadata/">Metadata</a>
|
||||||
</li>
|
</li>
|
||||||
|
|
||||||
|
<li >
|
||||||
|
<a href="../schemas/">Schemas</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
<li >
|
<li >
|
||||||
<a href="../format-suffixes/">Format suffixes</a>
|
<a href="../format-suffixes/">Format suffixes</a>
|
||||||
</li>
|
</li>
|
||||||
|
|
@ -234,6 +238,10 @@
|
||||||
<a href="../../topics/documenting-your-api/">Documenting your API</a>
|
<a href="../../topics/documenting-your-api/">Documenting your API</a>
|
||||||
</li>
|
</li>
|
||||||
|
|
||||||
|
<li >
|
||||||
|
<a href="../../topics/api-clients/">API Clients</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
<li >
|
<li >
|
||||||
<a href="../../topics/internationalization/">Internationalization</a>
|
<a href="../../topics/internationalization/">Internationalization</a>
|
||||||
</li>
|
</li>
|
||||||
|
|
|
||||||
|
|
@ -199,6 +199,10 @@
|
||||||
<a href="../metadata/">Metadata</a>
|
<a href="../metadata/">Metadata</a>
|
||||||
</li>
|
</li>
|
||||||
|
|
||||||
|
<li >
|
||||||
|
<a href="../schemas/">Schemas</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
<li >
|
<li >
|
||||||
<a href="../format-suffixes/">Format suffixes</a>
|
<a href="../format-suffixes/">Format suffixes</a>
|
||||||
</li>
|
</li>
|
||||||
|
|
@ -234,6 +238,10 @@
|
||||||
<a href="../../topics/documenting-your-api/">Documenting your API</a>
|
<a href="../../topics/documenting-your-api/">Documenting your API</a>
|
||||||
</li>
|
</li>
|
||||||
|
|
||||||
|
<li >
|
||||||
|
<a href="../../topics/api-clients/">API Clients</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
<li >
|
<li >
|
||||||
<a href="../../topics/internationalization/">Internationalization</a>
|
<a href="../../topics/internationalization/">Internationalization</a>
|
||||||
</li>
|
</li>
|
||||||
|
|
@ -605,7 +613,7 @@ in the <code>.validate()</code> method, or else in the view.</p>
|
||||||
|
|
||||||
class Meta:
|
class Meta:
|
||||||
fields = ('client', 'date', 'amount')
|
fields = ('client', 'date', 'amount')
|
||||||
extra_kwargs = {'client' {'required': 'False'}}
|
extra_kwargs = {'client': {'required': 'False'}}
|
||||||
validators = [] # Remove a default "unique together" constraint.
|
validators = [] # Remove a default "unique together" constraint.
|
||||||
</code></pre>
|
</code></pre>
|
||||||
<h2 id="updating-nested-serializers"><a class="toclink" href="#updating-nested-serializers">Updating nested serializers</a></h2>
|
<h2 id="updating-nested-serializers"><a class="toclink" href="#updating-nested-serializers">Updating nested serializers</a></h2>
|
||||||
|
|
|
||||||
|
|
@ -199,6 +199,10 @@
|
||||||
<a href="../metadata/">Metadata</a>
|
<a href="../metadata/">Metadata</a>
|
||||||
</li>
|
</li>
|
||||||
|
|
||||||
|
<li >
|
||||||
|
<a href="../schemas/">Schemas</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
<li >
|
<li >
|
||||||
<a href="../format-suffixes/">Format suffixes</a>
|
<a href="../format-suffixes/">Format suffixes</a>
|
||||||
</li>
|
</li>
|
||||||
|
|
@ -234,6 +238,10 @@
|
||||||
<a href="../../topics/documenting-your-api/">Documenting your API</a>
|
<a href="../../topics/documenting-your-api/">Documenting your API</a>
|
||||||
</li>
|
</li>
|
||||||
|
|
||||||
|
<li >
|
||||||
|
<a href="../../topics/api-clients/">API Clients</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
<li >
|
<li >
|
||||||
<a href="../../topics/internationalization/">Internationalization</a>
|
<a href="../../topics/internationalization/">Internationalization</a>
|
||||||
</li>
|
</li>
|
||||||
|
|
|
||||||
|
|
@ -199,6 +199,10 @@
|
||||||
<a href="../metadata/">Metadata</a>
|
<a href="../metadata/">Metadata</a>
|
||||||
</li>
|
</li>
|
||||||
|
|
||||||
|
<li >
|
||||||
|
<a href="../schemas/">Schemas</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
<li >
|
<li >
|
||||||
<a href="../format-suffixes/">Format suffixes</a>
|
<a href="../format-suffixes/">Format suffixes</a>
|
||||||
</li>
|
</li>
|
||||||
|
|
@ -234,6 +238,10 @@
|
||||||
<a href="../../topics/documenting-your-api/">Documenting your API</a>
|
<a href="../../topics/documenting-your-api/">Documenting your API</a>
|
||||||
</li>
|
</li>
|
||||||
|
|
||||||
|
<li >
|
||||||
|
<a href="../../topics/api-clients/">API Clients</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
<li >
|
<li >
|
||||||
<a href="../../topics/internationalization/">Internationalization</a>
|
<a href="../../topics/internationalization/">Internationalization</a>
|
||||||
</li>
|
</li>
|
||||||
|
|
|
||||||
|
|
@ -199,6 +199,10 @@
|
||||||
<a href="../metadata/">Metadata</a>
|
<a href="../metadata/">Metadata</a>
|
||||||
</li>
|
</li>
|
||||||
|
|
||||||
|
<li >
|
||||||
|
<a href="../schemas/">Schemas</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
<li >
|
<li >
|
||||||
<a href="../format-suffixes/">Format suffixes</a>
|
<a href="../format-suffixes/">Format suffixes</a>
|
||||||
</li>
|
</li>
|
||||||
|
|
@ -234,6 +238,10 @@
|
||||||
<a href="../../topics/documenting-your-api/">Documenting your API</a>
|
<a href="../../topics/documenting-your-api/">Documenting your API</a>
|
||||||
</li>
|
</li>
|
||||||
|
|
||||||
|
<li >
|
||||||
|
<a href="../../topics/api-clients/">API Clients</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
<li >
|
<li >
|
||||||
<a href="../../topics/internationalization/">Internationalization</a>
|
<a href="../../topics/internationalization/">Internationalization</a>
|
||||||
</li>
|
</li>
|
||||||
|
|
|
||||||
BIN
img/.DS_Store
vendored
Normal file
BIN
img/.DS_Store
vendored
Normal file
Binary file not shown.
BIN
img/corejson-format.png
Normal file
BIN
img/corejson-format.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 20 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 64 KiB After Width: | Height: | Size: 49 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 25 KiB After Width: | Height: | Size: 21 KiB |
BIN
img/premium/stream-readme.png
Normal file
BIN
img/premium/stream-readme.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 14 KiB |
17
index.html
17
index.html
|
|
@ -199,6 +199,10 @@
|
||||||
<a href="api-guide/metadata/">Metadata</a>
|
<a href="api-guide/metadata/">Metadata</a>
|
||||||
</li>
|
</li>
|
||||||
|
|
||||||
|
<li >
|
||||||
|
<a href="api-guide/schemas/">Schemas</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
<li >
|
<li >
|
||||||
<a href="api-guide/format-suffixes/">Format suffixes</a>
|
<a href="api-guide/format-suffixes/">Format suffixes</a>
|
||||||
</li>
|
</li>
|
||||||
|
|
@ -234,6 +238,10 @@
|
||||||
<a href="topics/documenting-your-api/">Documenting your API</a>
|
<a href="topics/documenting-your-api/">Documenting your API</a>
|
||||||
</li>
|
</li>
|
||||||
|
|
||||||
|
<li >
|
||||||
|
<a href="topics/api-clients/">API Clients</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
<li >
|
<li >
|
||||||
<a href="topics/internationalization/">Internationalization</a>
|
<a href="topics/internationalization/">Internationalization</a>
|
||||||
</li>
|
</li>
|
||||||
|
|
@ -498,17 +506,17 @@
|
||||||
REST framework commercially we strongly encourage you to invest in its
|
REST framework commercially we strongly encourage you to invest in its
|
||||||
continued development by <strong><a href="topics/funding/">signing up for a paid plan</a></strong>.</p>
|
continued development by <strong><a href="topics/funding/">signing up for a paid plan</a></strong>.</p>
|
||||||
<p>The initial aim is to provide a single full-time position on REST framework.
|
<p>The initial aim is to provide a single full-time position on REST framework.
|
||||||
Right now we're a little over 43% of the way towards achieving that.
|
Right now we're over 58% of the way towards achieving that.
|
||||||
<em>Every single sign-up makes a significant impact.</em> Taking out a
|
<em>Every single sign-up makes a significant impact.</em></p>
|
||||||
<a href="https://fund.django-rest-framework.org/topics/funding/#corporate-plans">basic tier sponsorship</a> moves us about 1% closer to our funding target.</p>
|
|
||||||
<ul class="premium-promo promo">
|
<ul class="premium-promo promo">
|
||||||
<li><a href="http://jobs.rover.com/" style="background-image: url(https://fund-rest-framework.s3.amazonaws.com/rover_130x130.png)">Rover.com</a></li>
|
<li><a href="http://jobs.rover.com/" style="background-image: url(https://fund-rest-framework.s3.amazonaws.com/rover_130x130.png)">Rover.com</a></li>
|
||||||
<li><a href="https://getsentry.com/welcome/" style="background-image: url(https://fund-rest-framework.s3.amazonaws.com/sentry130.png)">Sentry</a></li>
|
<li><a href="https://getsentry.com/welcome/" style="background-image: url(https://fund-rest-framework.s3.amazonaws.com/sentry130.png)">Sentry</a></li>
|
||||||
|
<li><a href="https://getstream.io/?utm_source=drf&utm_medium=banner&utm_campaign=drf" style="background-image: url(https://fund-rest-framework.s3.amazonaws.com/stream-130.png)">Stream</a></li>
|
||||||
</ul>
|
</ul>
|
||||||
|
|
||||||
<div style="clear: both; padding-bottom: 20px;"></div>
|
<div style="clear: both; padding-bottom: 20px;"></div>
|
||||||
|
|
||||||
<p><em>Many thanks to all our <a href="https://fund.django-rest-framework.org/topics/funding/#our-sponsors">awesome sponsors</a>, and in particular to our premium backers, <a href="http://jobs.rover.com/">Rover</a> and <a href="https://getsentry.com/welcome/">Sentry</a>.</em></p>
|
<p><em>Many thanks to all our <a href="https://fund.django-rest-framework.org/topics/funding/#our-sponsors">awesome sponsors</a>, and in particular to our premium backers, <a href="http://jobs.rover.com/">Rover</a>, <a href="https://getsentry.com/welcome/">Sentry</a>, and <a href="https://getstream.io/?utm_source=drf&utm_medium=banner&utm_campaign=drf">Stream</a>.</em></p>
|
||||||
<hr />
|
<hr />
|
||||||
<h2 id="requirements"><a class="toclink" href="#requirements">Requirements</a></h2>
|
<h2 id="requirements"><a class="toclink" href="#requirements">Requirements</a></h2>
|
||||||
<p>REST framework requires the following:</p>
|
<p>REST framework requires the following:</p>
|
||||||
|
|
@ -518,6 +526,7 @@ Right now we're a little over 43% of the way towards achieving that.
|
||||||
</ul>
|
</ul>
|
||||||
<p>The following packages are optional:</p>
|
<p>The following packages are optional:</p>
|
||||||
<ul>
|
<ul>
|
||||||
|
<li><a href="http://pypi.python.org/pypi/coreapi/">coreapi</a> (1.21.0+) - Schema generation support.</li>
|
||||||
<li><a href="http://pypi.python.org/pypi/Markdown/">Markdown</a> (2.1.0+) - Markdown support for the browsable API.</li>
|
<li><a href="http://pypi.python.org/pypi/Markdown/">Markdown</a> (2.1.0+) - Markdown support for the browsable API.</li>
|
||||||
<li><a href="http://pypi.python.org/pypi/django-filter">django-filter</a> (0.9.2+) - Filtering support.</li>
|
<li><a href="http://pypi.python.org/pypi/django-filter">django-filter</a> (0.9.2+) - Filtering support.</li>
|
||||||
<li><a href="https://github.com/maraujop/django-crispy-forms">django-crispy-forms</a> - Improved HTML display for filtering.</li>
|
<li><a href="https://github.com/maraujop/django-crispy-forms">django-crispy-forms</a> - Improved HTML display for filtering.</li>
|
||||||
|
|
|
||||||
File diff suppressed because one or more lines are too long
116
sitemap.xml
116
sitemap.xml
|
|
@ -4,7 +4,7 @@
|
||||||
|
|
||||||
<url>
|
<url>
|
||||||
<loc>http://www.django-rest-framework.org//</loc>
|
<loc>http://www.django-rest-framework.org//</loc>
|
||||||
<lastmod>2016-06-24</lastmod>
|
<lastmod>2016-07-07</lastmod>
|
||||||
<changefreq>daily</changefreq>
|
<changefreq>daily</changefreq>
|
||||||
</url>
|
</url>
|
||||||
|
|
||||||
|
|
@ -13,43 +13,43 @@
|
||||||
|
|
||||||
<url>
|
<url>
|
||||||
<loc>http://www.django-rest-framework.org//tutorial/quickstart/</loc>
|
<loc>http://www.django-rest-framework.org//tutorial/quickstart/</loc>
|
||||||
<lastmod>2016-06-24</lastmod>
|
<lastmod>2016-07-07</lastmod>
|
||||||
<changefreq>daily</changefreq>
|
<changefreq>daily</changefreq>
|
||||||
</url>
|
</url>
|
||||||
|
|
||||||
<url>
|
<url>
|
||||||
<loc>http://www.django-rest-framework.org//tutorial/1-serialization/</loc>
|
<loc>http://www.django-rest-framework.org//tutorial/1-serialization/</loc>
|
||||||
<lastmod>2016-06-24</lastmod>
|
<lastmod>2016-07-07</lastmod>
|
||||||
<changefreq>daily</changefreq>
|
<changefreq>daily</changefreq>
|
||||||
</url>
|
</url>
|
||||||
|
|
||||||
<url>
|
<url>
|
||||||
<loc>http://www.django-rest-framework.org//tutorial/2-requests-and-responses/</loc>
|
<loc>http://www.django-rest-framework.org//tutorial/2-requests-and-responses/</loc>
|
||||||
<lastmod>2016-06-24</lastmod>
|
<lastmod>2016-07-07</lastmod>
|
||||||
<changefreq>daily</changefreq>
|
<changefreq>daily</changefreq>
|
||||||
</url>
|
</url>
|
||||||
|
|
||||||
<url>
|
<url>
|
||||||
<loc>http://www.django-rest-framework.org//tutorial/3-class-based-views/</loc>
|
<loc>http://www.django-rest-framework.org//tutorial/3-class-based-views/</loc>
|
||||||
<lastmod>2016-06-24</lastmod>
|
<lastmod>2016-07-07</lastmod>
|
||||||
<changefreq>daily</changefreq>
|
<changefreq>daily</changefreq>
|
||||||
</url>
|
</url>
|
||||||
|
|
||||||
<url>
|
<url>
|
||||||
<loc>http://www.django-rest-framework.org//tutorial/4-authentication-and-permissions/</loc>
|
<loc>http://www.django-rest-framework.org//tutorial/4-authentication-and-permissions/</loc>
|
||||||
<lastmod>2016-06-24</lastmod>
|
<lastmod>2016-07-07</lastmod>
|
||||||
<changefreq>daily</changefreq>
|
<changefreq>daily</changefreq>
|
||||||
</url>
|
</url>
|
||||||
|
|
||||||
<url>
|
<url>
|
||||||
<loc>http://www.django-rest-framework.org//tutorial/5-relationships-and-hyperlinked-apis/</loc>
|
<loc>http://www.django-rest-framework.org//tutorial/5-relationships-and-hyperlinked-apis/</loc>
|
||||||
<lastmod>2016-06-24</lastmod>
|
<lastmod>2016-07-07</lastmod>
|
||||||
<changefreq>daily</changefreq>
|
<changefreq>daily</changefreq>
|
||||||
</url>
|
</url>
|
||||||
|
|
||||||
<url>
|
<url>
|
||||||
<loc>http://www.django-rest-framework.org//tutorial/6-viewsets-and-routers/</loc>
|
<loc>http://www.django-rest-framework.org//tutorial/6-viewsets-and-routers/</loc>
|
||||||
<lastmod>2016-06-24</lastmod>
|
<lastmod>2016-07-07</lastmod>
|
||||||
<changefreq>daily</changefreq>
|
<changefreq>daily</changefreq>
|
||||||
</url>
|
</url>
|
||||||
|
|
||||||
|
|
@ -59,157 +59,163 @@
|
||||||
|
|
||||||
<url>
|
<url>
|
||||||
<loc>http://www.django-rest-framework.org//api-guide/requests/</loc>
|
<loc>http://www.django-rest-framework.org//api-guide/requests/</loc>
|
||||||
<lastmod>2016-06-24</lastmod>
|
<lastmod>2016-07-07</lastmod>
|
||||||
<changefreq>daily</changefreq>
|
<changefreq>daily</changefreq>
|
||||||
</url>
|
</url>
|
||||||
|
|
||||||
<url>
|
<url>
|
||||||
<loc>http://www.django-rest-framework.org//api-guide/responses/</loc>
|
<loc>http://www.django-rest-framework.org//api-guide/responses/</loc>
|
||||||
<lastmod>2016-06-24</lastmod>
|
<lastmod>2016-07-07</lastmod>
|
||||||
<changefreq>daily</changefreq>
|
<changefreq>daily</changefreq>
|
||||||
</url>
|
</url>
|
||||||
|
|
||||||
<url>
|
<url>
|
||||||
<loc>http://www.django-rest-framework.org//api-guide/views/</loc>
|
<loc>http://www.django-rest-framework.org//api-guide/views/</loc>
|
||||||
<lastmod>2016-06-24</lastmod>
|
<lastmod>2016-07-07</lastmod>
|
||||||
<changefreq>daily</changefreq>
|
<changefreq>daily</changefreq>
|
||||||
</url>
|
</url>
|
||||||
|
|
||||||
<url>
|
<url>
|
||||||
<loc>http://www.django-rest-framework.org//api-guide/generic-views/</loc>
|
<loc>http://www.django-rest-framework.org//api-guide/generic-views/</loc>
|
||||||
<lastmod>2016-06-24</lastmod>
|
<lastmod>2016-07-07</lastmod>
|
||||||
<changefreq>daily</changefreq>
|
<changefreq>daily</changefreq>
|
||||||
</url>
|
</url>
|
||||||
|
|
||||||
<url>
|
<url>
|
||||||
<loc>http://www.django-rest-framework.org//api-guide/viewsets/</loc>
|
<loc>http://www.django-rest-framework.org//api-guide/viewsets/</loc>
|
||||||
<lastmod>2016-06-24</lastmod>
|
<lastmod>2016-07-07</lastmod>
|
||||||
<changefreq>daily</changefreq>
|
<changefreq>daily</changefreq>
|
||||||
</url>
|
</url>
|
||||||
|
|
||||||
<url>
|
<url>
|
||||||
<loc>http://www.django-rest-framework.org//api-guide/routers/</loc>
|
<loc>http://www.django-rest-framework.org//api-guide/routers/</loc>
|
||||||
<lastmod>2016-06-24</lastmod>
|
<lastmod>2016-07-07</lastmod>
|
||||||
<changefreq>daily</changefreq>
|
<changefreq>daily</changefreq>
|
||||||
</url>
|
</url>
|
||||||
|
|
||||||
<url>
|
<url>
|
||||||
<loc>http://www.django-rest-framework.org//api-guide/parsers/</loc>
|
<loc>http://www.django-rest-framework.org//api-guide/parsers/</loc>
|
||||||
<lastmod>2016-06-24</lastmod>
|
<lastmod>2016-07-07</lastmod>
|
||||||
<changefreq>daily</changefreq>
|
<changefreq>daily</changefreq>
|
||||||
</url>
|
</url>
|
||||||
|
|
||||||
<url>
|
<url>
|
||||||
<loc>http://www.django-rest-framework.org//api-guide/renderers/</loc>
|
<loc>http://www.django-rest-framework.org//api-guide/renderers/</loc>
|
||||||
<lastmod>2016-06-24</lastmod>
|
<lastmod>2016-07-07</lastmod>
|
||||||
<changefreq>daily</changefreq>
|
<changefreq>daily</changefreq>
|
||||||
</url>
|
</url>
|
||||||
|
|
||||||
<url>
|
<url>
|
||||||
<loc>http://www.django-rest-framework.org//api-guide/serializers/</loc>
|
<loc>http://www.django-rest-framework.org//api-guide/serializers/</loc>
|
||||||
<lastmod>2016-06-24</lastmod>
|
<lastmod>2016-07-07</lastmod>
|
||||||
<changefreq>daily</changefreq>
|
<changefreq>daily</changefreq>
|
||||||
</url>
|
</url>
|
||||||
|
|
||||||
<url>
|
<url>
|
||||||
<loc>http://www.django-rest-framework.org//api-guide/fields/</loc>
|
<loc>http://www.django-rest-framework.org//api-guide/fields/</loc>
|
||||||
<lastmod>2016-06-24</lastmod>
|
<lastmod>2016-07-07</lastmod>
|
||||||
<changefreq>daily</changefreq>
|
<changefreq>daily</changefreq>
|
||||||
</url>
|
</url>
|
||||||
|
|
||||||
<url>
|
<url>
|
||||||
<loc>http://www.django-rest-framework.org//api-guide/relations/</loc>
|
<loc>http://www.django-rest-framework.org//api-guide/relations/</loc>
|
||||||
<lastmod>2016-06-24</lastmod>
|
<lastmod>2016-07-07</lastmod>
|
||||||
<changefreq>daily</changefreq>
|
<changefreq>daily</changefreq>
|
||||||
</url>
|
</url>
|
||||||
|
|
||||||
<url>
|
<url>
|
||||||
<loc>http://www.django-rest-framework.org//api-guide/validators/</loc>
|
<loc>http://www.django-rest-framework.org//api-guide/validators/</loc>
|
||||||
<lastmod>2016-06-24</lastmod>
|
<lastmod>2016-07-07</lastmod>
|
||||||
<changefreq>daily</changefreq>
|
<changefreq>daily</changefreq>
|
||||||
</url>
|
</url>
|
||||||
|
|
||||||
<url>
|
<url>
|
||||||
<loc>http://www.django-rest-framework.org//api-guide/authentication/</loc>
|
<loc>http://www.django-rest-framework.org//api-guide/authentication/</loc>
|
||||||
<lastmod>2016-06-24</lastmod>
|
<lastmod>2016-07-07</lastmod>
|
||||||
<changefreq>daily</changefreq>
|
<changefreq>daily</changefreq>
|
||||||
</url>
|
</url>
|
||||||
|
|
||||||
<url>
|
<url>
|
||||||
<loc>http://www.django-rest-framework.org//api-guide/permissions/</loc>
|
<loc>http://www.django-rest-framework.org//api-guide/permissions/</loc>
|
||||||
<lastmod>2016-06-24</lastmod>
|
<lastmod>2016-07-07</lastmod>
|
||||||
<changefreq>daily</changefreq>
|
<changefreq>daily</changefreq>
|
||||||
</url>
|
</url>
|
||||||
|
|
||||||
<url>
|
<url>
|
||||||
<loc>http://www.django-rest-framework.org//api-guide/throttling/</loc>
|
<loc>http://www.django-rest-framework.org//api-guide/throttling/</loc>
|
||||||
<lastmod>2016-06-24</lastmod>
|
<lastmod>2016-07-07</lastmod>
|
||||||
<changefreq>daily</changefreq>
|
<changefreq>daily</changefreq>
|
||||||
</url>
|
</url>
|
||||||
|
|
||||||
<url>
|
<url>
|
||||||
<loc>http://www.django-rest-framework.org//api-guide/filtering/</loc>
|
<loc>http://www.django-rest-framework.org//api-guide/filtering/</loc>
|
||||||
<lastmod>2016-06-24</lastmod>
|
<lastmod>2016-07-07</lastmod>
|
||||||
<changefreq>daily</changefreq>
|
<changefreq>daily</changefreq>
|
||||||
</url>
|
</url>
|
||||||
|
|
||||||
<url>
|
<url>
|
||||||
<loc>http://www.django-rest-framework.org//api-guide/pagination/</loc>
|
<loc>http://www.django-rest-framework.org//api-guide/pagination/</loc>
|
||||||
<lastmod>2016-06-24</lastmod>
|
<lastmod>2016-07-07</lastmod>
|
||||||
<changefreq>daily</changefreq>
|
<changefreq>daily</changefreq>
|
||||||
</url>
|
</url>
|
||||||
|
|
||||||
<url>
|
<url>
|
||||||
<loc>http://www.django-rest-framework.org//api-guide/versioning/</loc>
|
<loc>http://www.django-rest-framework.org//api-guide/versioning/</loc>
|
||||||
<lastmod>2016-06-24</lastmod>
|
<lastmod>2016-07-07</lastmod>
|
||||||
<changefreq>daily</changefreq>
|
<changefreq>daily</changefreq>
|
||||||
</url>
|
</url>
|
||||||
|
|
||||||
<url>
|
<url>
|
||||||
<loc>http://www.django-rest-framework.org//api-guide/content-negotiation/</loc>
|
<loc>http://www.django-rest-framework.org//api-guide/content-negotiation/</loc>
|
||||||
<lastmod>2016-06-24</lastmod>
|
<lastmod>2016-07-07</lastmod>
|
||||||
<changefreq>daily</changefreq>
|
<changefreq>daily</changefreq>
|
||||||
</url>
|
</url>
|
||||||
|
|
||||||
<url>
|
<url>
|
||||||
<loc>http://www.django-rest-framework.org//api-guide/metadata/</loc>
|
<loc>http://www.django-rest-framework.org//api-guide/metadata/</loc>
|
||||||
<lastmod>2016-06-24</lastmod>
|
<lastmod>2016-07-07</lastmod>
|
||||||
|
<changefreq>daily</changefreq>
|
||||||
|
</url>
|
||||||
|
|
||||||
|
<url>
|
||||||
|
<loc>http://www.django-rest-framework.org//api-guide/schemas/</loc>
|
||||||
|
<lastmod>2016-07-07</lastmod>
|
||||||
<changefreq>daily</changefreq>
|
<changefreq>daily</changefreq>
|
||||||
</url>
|
</url>
|
||||||
|
|
||||||
<url>
|
<url>
|
||||||
<loc>http://www.django-rest-framework.org//api-guide/format-suffixes/</loc>
|
<loc>http://www.django-rest-framework.org//api-guide/format-suffixes/</loc>
|
||||||
<lastmod>2016-06-24</lastmod>
|
<lastmod>2016-07-07</lastmod>
|
||||||
<changefreq>daily</changefreq>
|
<changefreq>daily</changefreq>
|
||||||
</url>
|
</url>
|
||||||
|
|
||||||
<url>
|
<url>
|
||||||
<loc>http://www.django-rest-framework.org//api-guide/reverse/</loc>
|
<loc>http://www.django-rest-framework.org//api-guide/reverse/</loc>
|
||||||
<lastmod>2016-06-24</lastmod>
|
<lastmod>2016-07-07</lastmod>
|
||||||
<changefreq>daily</changefreq>
|
<changefreq>daily</changefreq>
|
||||||
</url>
|
</url>
|
||||||
|
|
||||||
<url>
|
<url>
|
||||||
<loc>http://www.django-rest-framework.org//api-guide/exceptions/</loc>
|
<loc>http://www.django-rest-framework.org//api-guide/exceptions/</loc>
|
||||||
<lastmod>2016-06-24</lastmod>
|
<lastmod>2016-07-07</lastmod>
|
||||||
<changefreq>daily</changefreq>
|
<changefreq>daily</changefreq>
|
||||||
</url>
|
</url>
|
||||||
|
|
||||||
<url>
|
<url>
|
||||||
<loc>http://www.django-rest-framework.org//api-guide/status-codes/</loc>
|
<loc>http://www.django-rest-framework.org//api-guide/status-codes/</loc>
|
||||||
<lastmod>2016-06-24</lastmod>
|
<lastmod>2016-07-07</lastmod>
|
||||||
<changefreq>daily</changefreq>
|
<changefreq>daily</changefreq>
|
||||||
</url>
|
</url>
|
||||||
|
|
||||||
<url>
|
<url>
|
||||||
<loc>http://www.django-rest-framework.org//api-guide/testing/</loc>
|
<loc>http://www.django-rest-framework.org//api-guide/testing/</loc>
|
||||||
<lastmod>2016-06-24</lastmod>
|
<lastmod>2016-07-07</lastmod>
|
||||||
<changefreq>daily</changefreq>
|
<changefreq>daily</changefreq>
|
||||||
</url>
|
</url>
|
||||||
|
|
||||||
<url>
|
<url>
|
||||||
<loc>http://www.django-rest-framework.org//api-guide/settings/</loc>
|
<loc>http://www.django-rest-framework.org//api-guide/settings/</loc>
|
||||||
<lastmod>2016-06-24</lastmod>
|
<lastmod>2016-07-07</lastmod>
|
||||||
<changefreq>daily</changefreq>
|
<changefreq>daily</changefreq>
|
||||||
</url>
|
</url>
|
||||||
|
|
||||||
|
|
@ -219,109 +225,115 @@
|
||||||
|
|
||||||
<url>
|
<url>
|
||||||
<loc>http://www.django-rest-framework.org//topics/documenting-your-api/</loc>
|
<loc>http://www.django-rest-framework.org//topics/documenting-your-api/</loc>
|
||||||
<lastmod>2016-06-24</lastmod>
|
<lastmod>2016-07-07</lastmod>
|
||||||
|
<changefreq>daily</changefreq>
|
||||||
|
</url>
|
||||||
|
|
||||||
|
<url>
|
||||||
|
<loc>http://www.django-rest-framework.org//topics/api-clients/</loc>
|
||||||
|
<lastmod>2016-07-07</lastmod>
|
||||||
<changefreq>daily</changefreq>
|
<changefreq>daily</changefreq>
|
||||||
</url>
|
</url>
|
||||||
|
|
||||||
<url>
|
<url>
|
||||||
<loc>http://www.django-rest-framework.org//topics/internationalization/</loc>
|
<loc>http://www.django-rest-framework.org//topics/internationalization/</loc>
|
||||||
<lastmod>2016-06-24</lastmod>
|
<lastmod>2016-07-07</lastmod>
|
||||||
<changefreq>daily</changefreq>
|
<changefreq>daily</changefreq>
|
||||||
</url>
|
</url>
|
||||||
|
|
||||||
<url>
|
<url>
|
||||||
<loc>http://www.django-rest-framework.org//topics/ajax-csrf-cors/</loc>
|
<loc>http://www.django-rest-framework.org//topics/ajax-csrf-cors/</loc>
|
||||||
<lastmod>2016-06-24</lastmod>
|
<lastmod>2016-07-07</lastmod>
|
||||||
<changefreq>daily</changefreq>
|
<changefreq>daily</changefreq>
|
||||||
</url>
|
</url>
|
||||||
|
|
||||||
<url>
|
<url>
|
||||||
<loc>http://www.django-rest-framework.org//topics/html-and-forms/</loc>
|
<loc>http://www.django-rest-framework.org//topics/html-and-forms/</loc>
|
||||||
<lastmod>2016-06-24</lastmod>
|
<lastmod>2016-07-07</lastmod>
|
||||||
<changefreq>daily</changefreq>
|
<changefreq>daily</changefreq>
|
||||||
</url>
|
</url>
|
||||||
|
|
||||||
<url>
|
<url>
|
||||||
<loc>http://www.django-rest-framework.org//topics/browser-enhancements/</loc>
|
<loc>http://www.django-rest-framework.org//topics/browser-enhancements/</loc>
|
||||||
<lastmod>2016-06-24</lastmod>
|
<lastmod>2016-07-07</lastmod>
|
||||||
<changefreq>daily</changefreq>
|
<changefreq>daily</changefreq>
|
||||||
</url>
|
</url>
|
||||||
|
|
||||||
<url>
|
<url>
|
||||||
<loc>http://www.django-rest-framework.org//topics/browsable-api/</loc>
|
<loc>http://www.django-rest-framework.org//topics/browsable-api/</loc>
|
||||||
<lastmod>2016-06-24</lastmod>
|
<lastmod>2016-07-07</lastmod>
|
||||||
<changefreq>daily</changefreq>
|
<changefreq>daily</changefreq>
|
||||||
</url>
|
</url>
|
||||||
|
|
||||||
<url>
|
<url>
|
||||||
<loc>http://www.django-rest-framework.org//topics/rest-hypermedia-hateoas/</loc>
|
<loc>http://www.django-rest-framework.org//topics/rest-hypermedia-hateoas/</loc>
|
||||||
<lastmod>2016-06-24</lastmod>
|
<lastmod>2016-07-07</lastmod>
|
||||||
<changefreq>daily</changefreq>
|
<changefreq>daily</changefreq>
|
||||||
</url>
|
</url>
|
||||||
|
|
||||||
<url>
|
<url>
|
||||||
<loc>http://www.django-rest-framework.org//topics/third-party-resources/</loc>
|
<loc>http://www.django-rest-framework.org//topics/third-party-resources/</loc>
|
||||||
<lastmod>2016-06-24</lastmod>
|
<lastmod>2016-07-07</lastmod>
|
||||||
<changefreq>daily</changefreq>
|
<changefreq>daily</changefreq>
|
||||||
</url>
|
</url>
|
||||||
|
|
||||||
<url>
|
<url>
|
||||||
<loc>http://www.django-rest-framework.org//topics/contributing/</loc>
|
<loc>http://www.django-rest-framework.org//topics/contributing/</loc>
|
||||||
<lastmod>2016-06-24</lastmod>
|
<lastmod>2016-07-07</lastmod>
|
||||||
<changefreq>daily</changefreq>
|
<changefreq>daily</changefreq>
|
||||||
</url>
|
</url>
|
||||||
|
|
||||||
<url>
|
<url>
|
||||||
<loc>http://www.django-rest-framework.org//topics/project-management/</loc>
|
<loc>http://www.django-rest-framework.org//topics/project-management/</loc>
|
||||||
<lastmod>2016-06-24</lastmod>
|
<lastmod>2016-07-07</lastmod>
|
||||||
<changefreq>daily</changefreq>
|
<changefreq>daily</changefreq>
|
||||||
</url>
|
</url>
|
||||||
|
|
||||||
<url>
|
<url>
|
||||||
<loc>http://www.django-rest-framework.org//topics/3.0-announcement/</loc>
|
<loc>http://www.django-rest-framework.org//topics/3.0-announcement/</loc>
|
||||||
<lastmod>2016-06-24</lastmod>
|
<lastmod>2016-07-07</lastmod>
|
||||||
<changefreq>daily</changefreq>
|
<changefreq>daily</changefreq>
|
||||||
</url>
|
</url>
|
||||||
|
|
||||||
<url>
|
<url>
|
||||||
<loc>http://www.django-rest-framework.org//topics/3.1-announcement/</loc>
|
<loc>http://www.django-rest-framework.org//topics/3.1-announcement/</loc>
|
||||||
<lastmod>2016-06-24</lastmod>
|
<lastmod>2016-07-07</lastmod>
|
||||||
<changefreq>daily</changefreq>
|
<changefreq>daily</changefreq>
|
||||||
</url>
|
</url>
|
||||||
|
|
||||||
<url>
|
<url>
|
||||||
<loc>http://www.django-rest-framework.org//topics/3.2-announcement/</loc>
|
<loc>http://www.django-rest-framework.org//topics/3.2-announcement/</loc>
|
||||||
<lastmod>2016-06-24</lastmod>
|
<lastmod>2016-07-07</lastmod>
|
||||||
<changefreq>daily</changefreq>
|
<changefreq>daily</changefreq>
|
||||||
</url>
|
</url>
|
||||||
|
|
||||||
<url>
|
<url>
|
||||||
<loc>http://www.django-rest-framework.org//topics/3.3-announcement/</loc>
|
<loc>http://www.django-rest-framework.org//topics/3.3-announcement/</loc>
|
||||||
<lastmod>2016-06-24</lastmod>
|
<lastmod>2016-07-07</lastmod>
|
||||||
<changefreq>daily</changefreq>
|
<changefreq>daily</changefreq>
|
||||||
</url>
|
</url>
|
||||||
|
|
||||||
<url>
|
<url>
|
||||||
<loc>http://www.django-rest-framework.org//topics/kickstarter-announcement/</loc>
|
<loc>http://www.django-rest-framework.org//topics/kickstarter-announcement/</loc>
|
||||||
<lastmod>2016-06-24</lastmod>
|
<lastmod>2016-07-07</lastmod>
|
||||||
<changefreq>daily</changefreq>
|
<changefreq>daily</changefreq>
|
||||||
</url>
|
</url>
|
||||||
|
|
||||||
<url>
|
<url>
|
||||||
<loc>http://www.django-rest-framework.org//topics/mozilla-grant/</loc>
|
<loc>http://www.django-rest-framework.org//topics/mozilla-grant/</loc>
|
||||||
<lastmod>2016-06-24</lastmod>
|
<lastmod>2016-07-07</lastmod>
|
||||||
<changefreq>daily</changefreq>
|
<changefreq>daily</changefreq>
|
||||||
</url>
|
</url>
|
||||||
|
|
||||||
<url>
|
<url>
|
||||||
<loc>http://www.django-rest-framework.org//topics/funding/</loc>
|
<loc>http://www.django-rest-framework.org//topics/funding/</loc>
|
||||||
<lastmod>2016-06-24</lastmod>
|
<lastmod>2016-07-07</lastmod>
|
||||||
<changefreq>daily</changefreq>
|
<changefreq>daily</changefreq>
|
||||||
</url>
|
</url>
|
||||||
|
|
||||||
<url>
|
<url>
|
||||||
<loc>http://www.django-rest-framework.org//topics/release-notes/</loc>
|
<loc>http://www.django-rest-framework.org//topics/release-notes/</loc>
|
||||||
<lastmod>2016-06-24</lastmod>
|
<lastmod>2016-07-07</lastmod>
|
||||||
<changefreq>daily</changefreq>
|
<changefreq>daily</changefreq>
|
||||||
</url>
|
</url>
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -199,6 +199,10 @@
|
||||||
<a href="../../api-guide/metadata/">Metadata</a>
|
<a href="../../api-guide/metadata/">Metadata</a>
|
||||||
</li>
|
</li>
|
||||||
|
|
||||||
|
<li >
|
||||||
|
<a href="../../api-guide/schemas/">Schemas</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
<li >
|
<li >
|
||||||
<a href="../../api-guide/format-suffixes/">Format suffixes</a>
|
<a href="../../api-guide/format-suffixes/">Format suffixes</a>
|
||||||
</li>
|
</li>
|
||||||
|
|
@ -234,6 +238,10 @@
|
||||||
<a href="../documenting-your-api/">Documenting your API</a>
|
<a href="../documenting-your-api/">Documenting your API</a>
|
||||||
</li>
|
</li>
|
||||||
|
|
||||||
|
<li >
|
||||||
|
<a href="../api-clients/">API Clients</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
<li >
|
<li >
|
||||||
<a href="../internationalization/">Internationalization</a>
|
<a href="../internationalization/">Internationalization</a>
|
||||||
</li>
|
</li>
|
||||||
|
|
|
||||||
|
|
@ -199,6 +199,10 @@
|
||||||
<a href="../../api-guide/metadata/">Metadata</a>
|
<a href="../../api-guide/metadata/">Metadata</a>
|
||||||
</li>
|
</li>
|
||||||
|
|
||||||
|
<li >
|
||||||
|
<a href="../../api-guide/schemas/">Schemas</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
<li >
|
<li >
|
||||||
<a href="../../api-guide/format-suffixes/">Format suffixes</a>
|
<a href="../../api-guide/format-suffixes/">Format suffixes</a>
|
||||||
</li>
|
</li>
|
||||||
|
|
@ -234,6 +238,10 @@
|
||||||
<a href="../documenting-your-api/">Documenting your API</a>
|
<a href="../documenting-your-api/">Documenting your API</a>
|
||||||
</li>
|
</li>
|
||||||
|
|
||||||
|
<li >
|
||||||
|
<a href="../api-clients/">API Clients</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
<li >
|
<li >
|
||||||
<a href="../internationalization/">Internationalization</a>
|
<a href="../internationalization/">Internationalization</a>
|
||||||
</li>
|
</li>
|
||||||
|
|
|
||||||
|
|
@ -199,6 +199,10 @@
|
||||||
<a href="../../api-guide/metadata/">Metadata</a>
|
<a href="../../api-guide/metadata/">Metadata</a>
|
||||||
</li>
|
</li>
|
||||||
|
|
||||||
|
<li >
|
||||||
|
<a href="../../api-guide/schemas/">Schemas</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
<li >
|
<li >
|
||||||
<a href="../../api-guide/format-suffixes/">Format suffixes</a>
|
<a href="../../api-guide/format-suffixes/">Format suffixes</a>
|
||||||
</li>
|
</li>
|
||||||
|
|
@ -234,6 +238,10 @@
|
||||||
<a href="../documenting-your-api/">Documenting your API</a>
|
<a href="../documenting-your-api/">Documenting your API</a>
|
||||||
</li>
|
</li>
|
||||||
|
|
||||||
|
<li >
|
||||||
|
<a href="../api-clients/">API Clients</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
<li >
|
<li >
|
||||||
<a href="../internationalization/">Internationalization</a>
|
<a href="../internationalization/">Internationalization</a>
|
||||||
</li>
|
</li>
|
||||||
|
|
|
||||||
|
|
@ -199,6 +199,10 @@
|
||||||
<a href="../../api-guide/metadata/">Metadata</a>
|
<a href="../../api-guide/metadata/">Metadata</a>
|
||||||
</li>
|
</li>
|
||||||
|
|
||||||
|
<li >
|
||||||
|
<a href="../../api-guide/schemas/">Schemas</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
<li >
|
<li >
|
||||||
<a href="../../api-guide/format-suffixes/">Format suffixes</a>
|
<a href="../../api-guide/format-suffixes/">Format suffixes</a>
|
||||||
</li>
|
</li>
|
||||||
|
|
@ -234,6 +238,10 @@
|
||||||
<a href="../documenting-your-api/">Documenting your API</a>
|
<a href="../documenting-your-api/">Documenting your API</a>
|
||||||
</li>
|
</li>
|
||||||
|
|
||||||
|
<li >
|
||||||
|
<a href="../api-clients/">API Clients</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
<li >
|
<li >
|
||||||
<a href="../internationalization/">Internationalization</a>
|
<a href="../internationalization/">Internationalization</a>
|
||||||
</li>
|
</li>
|
||||||
|
|
|
||||||
|
|
@ -199,6 +199,10 @@
|
||||||
<a href="../../api-guide/metadata/">Metadata</a>
|
<a href="../../api-guide/metadata/">Metadata</a>
|
||||||
</li>
|
</li>
|
||||||
|
|
||||||
|
<li >
|
||||||
|
<a href="../../api-guide/schemas/">Schemas</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
<li >
|
<li >
|
||||||
<a href="../../api-guide/format-suffixes/">Format suffixes</a>
|
<a href="../../api-guide/format-suffixes/">Format suffixes</a>
|
||||||
</li>
|
</li>
|
||||||
|
|
@ -234,6 +238,10 @@
|
||||||
<a href="../documenting-your-api/">Documenting your API</a>
|
<a href="../documenting-your-api/">Documenting your API</a>
|
||||||
</li>
|
</li>
|
||||||
|
|
||||||
|
<li >
|
||||||
|
<a href="../api-clients/">API Clients</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
<li >
|
<li >
|
||||||
<a href="../internationalization/">Internationalization</a>
|
<a href="../internationalization/">Internationalization</a>
|
||||||
</li>
|
</li>
|
||||||
|
|
|
||||||
687
topics/api-clients/index.html
Normal file
687
topics/api-clients/index.html
Normal file
|
|
@ -0,0 +1,687 @@
|
||||||
|
<!DOCTYPE html>
|
||||||
|
<html lang="en">
|
||||||
|
|
||||||
|
<head>
|
||||||
|
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
|
||||||
|
<meta charset="utf-8">
|
||||||
|
<title>API Clients - Django REST framework</title>
|
||||||
|
<link href="../../img/favicon.ico" rel="icon" type="image/x-icon">
|
||||||
|
<link rel="canonical" href="http://www.django-rest-framework.org/topics/api-clients/" />
|
||||||
|
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||||
|
<meta name="description" content="Django, API, REST, API Clients">
|
||||||
|
<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">
|
||||||
|
<a class="repo-link btn btn-primary btn-small" href="https://github.com/tomchristie/django-rest-framework/tree/master">GitHub</a>
|
||||||
|
<a class="repo-link btn btn-inverse btn-small " rel="prev" href="../internationalization/">
|
||||||
|
Next <i class="icon-arrow-right icon-white"></i>
|
||||||
|
</a>
|
||||||
|
<a class="repo-link btn btn-inverse btn-small " rel="next" href="../documenting-your-api/">
|
||||||
|
<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>
|
||||||
|
<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>
|
||||||
|
|
||||||
|
<li class="dropdown">
|
||||||
|
<a href="#" class="dropdown-toggle" data-toggle="dropdown">Tutorial <b class="caret"></b></a>
|
||||||
|
<ul class="dropdown-menu">
|
||||||
|
|
||||||
|
<li >
|
||||||
|
<a href="../../tutorial/quickstart/">Quickstart</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li >
|
||||||
|
<a href="../../tutorial/1-serialization/">1 - Serialization</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li >
|
||||||
|
<a href="../../tutorial/2-requests-and-responses/">2 - Requests and responses</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li >
|
||||||
|
<a href="../../tutorial/3-class-based-views/">3 - Class based views</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li >
|
||||||
|
<a href="../../tutorial/4-authentication-and-permissions/">4 - Authentication and permissions</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li >
|
||||||
|
<a href="../../tutorial/5-relationships-and-hyperlinked-apis/">5 - Relationships and hyperlinked APIs</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li >
|
||||||
|
<a href="../../tutorial/6-viewsets-and-routers/">6 - Viewsets and routers</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
|
</ul>
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li class="dropdown">
|
||||||
|
<a href="#" class="dropdown-toggle" data-toggle="dropdown">API Guide <b class="caret"></b></a>
|
||||||
|
<ul class="dropdown-menu">
|
||||||
|
|
||||||
|
<li >
|
||||||
|
<a href="../../api-guide/requests/">Requests</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li >
|
||||||
|
<a href="../../api-guide/responses/">Responses</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li >
|
||||||
|
<a href="../../api-guide/views/">Views</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li >
|
||||||
|
<a href="../../api-guide/generic-views/">Generic views</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li >
|
||||||
|
<a href="../../api-guide/viewsets/">Viewsets</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li >
|
||||||
|
<a href="../../api-guide/routers/">Routers</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li >
|
||||||
|
<a href="../../api-guide/parsers/">Parsers</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li >
|
||||||
|
<a href="../../api-guide/renderers/">Renderers</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li >
|
||||||
|
<a href="../../api-guide/serializers/">Serializers</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li >
|
||||||
|
<a href="../../api-guide/fields/">Serializer fields</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li >
|
||||||
|
<a href="../../api-guide/relations/">Serializer relations</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li >
|
||||||
|
<a href="../../api-guide/validators/">Validators</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li >
|
||||||
|
<a href="../../api-guide/authentication/">Authentication</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li >
|
||||||
|
<a href="../../api-guide/permissions/">Permissions</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li >
|
||||||
|
<a href="../../api-guide/throttling/">Throttling</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li >
|
||||||
|
<a href="../../api-guide/filtering/">Filtering</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li >
|
||||||
|
<a href="../../api-guide/pagination/">Pagination</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li >
|
||||||
|
<a href="../../api-guide/versioning/">Versioning</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li >
|
||||||
|
<a href="../../api-guide/content-negotiation/">Content negotiation</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li >
|
||||||
|
<a href="../../api-guide/metadata/">Metadata</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li >
|
||||||
|
<a href="../../api-guide/schemas/">Schemas</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li >
|
||||||
|
<a href="../../api-guide/format-suffixes/">Format suffixes</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li >
|
||||||
|
<a href="../../api-guide/reverse/">Returning URLs</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li >
|
||||||
|
<a href="../../api-guide/exceptions/">Exceptions</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li >
|
||||||
|
<a href="../../api-guide/status-codes/">Status codes</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li >
|
||||||
|
<a href="../../api-guide/testing/">Testing</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li >
|
||||||
|
<a href="../../api-guide/settings/">Settings</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
|
</ul>
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li class="dropdown active">
|
||||||
|
<a href="#" class="dropdown-toggle" data-toggle="dropdown">Topics <b class="caret"></b></a>
|
||||||
|
<ul class="dropdown-menu">
|
||||||
|
|
||||||
|
<li >
|
||||||
|
<a href="../documenting-your-api/">Documenting your API</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li class="active" >
|
||||||
|
<a href="./">API Clients</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li >
|
||||||
|
<a href="../internationalization/">Internationalization</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li >
|
||||||
|
<a href="../ajax-csrf-cors/">AJAX, CSRF & CORS</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li >
|
||||||
|
<a href="../html-and-forms/">HTML & Forms</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li >
|
||||||
|
<a href="../browser-enhancements/">Browser Enhancements</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li >
|
||||||
|
<a href="../browsable-api/">The Browsable API</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li >
|
||||||
|
<a href="../rest-hypermedia-hateoas/">REST, Hypermedia & HATEOAS</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li >
|
||||||
|
<a href="../third-party-resources/">Third Party Resources</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li >
|
||||||
|
<a href="../contributing/">Contributing to REST framework</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li >
|
||||||
|
<a href="../project-management/">Project management</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li >
|
||||||
|
<a href="../3.0-announcement/">3.0 Announcement</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li >
|
||||||
|
<a href="../3.1-announcement/">3.1 Announcement</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li >
|
||||||
|
<a href="../3.2-announcement/">3.2 Announcement</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li >
|
||||||
|
<a href="../3.3-announcement/">3.3 Announcement</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li >
|
||||||
|
<a href="../kickstarter-announcement/">Kickstarter Announcement</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li >
|
||||||
|
<a href="../mozilla-grant/">Mozilla Grant</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li >
|
||||||
|
<a href="../funding/">Funding</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li >
|
||||||
|
<a href="../release-notes/">Release Notes</a>
|
||||||
|
</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">
|
||||||
|
<a href="#api-clients">API Clients</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
|
|
||||||
|
<li>
|
||||||
|
<a href="#client-side-core-api">Client-side Core API</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
|
|
||||||
|
<li class="main">
|
||||||
|
<a href="#command-line-client">Command line client</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
|
|
||||||
|
<li>
|
||||||
|
<a href="#getting-started">Getting started</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li>
|
||||||
|
<a href="#authentication-headers">Authentication & headers</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li>
|
||||||
|
<a href="#utilities">Utilities</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li>
|
||||||
|
<a href="#other-commands">Other commands</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
|
|
||||||
|
<li class="main">
|
||||||
|
<a href="#python-client-library">Python client library</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
|
|
||||||
|
<li>
|
||||||
|
<a href="#getting-started_1">Getting started</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li>
|
||||||
|
<a href="#codecs">Codecs</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li>
|
||||||
|
<a href="#transports">Transports</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<div class="promo">
|
||||||
|
<hr/>
|
||||||
|
<div id="sidebarInclude">
|
||||||
|
</div>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
<div id="main-content" class="span9">
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<h1 id="api-clients"><a class="toclink" href="#api-clients">API Clients</a></h1>
|
||||||
|
<p>An API client handles the underlying details of how network requests are made
|
||||||
|
and how responses are decoded. They present the developer with an application
|
||||||
|
interface to work against, rather than working directly with the network interface.</p>
|
||||||
|
<p>The API clients documented here are not restricted to APIs built with Django REST framework.
|
||||||
|
They can be used with any API that exposes a supported schema format.</p>
|
||||||
|
<p>For example, <a href="https://devcenter.heroku.com/categories/platform-api">the Heroku platform API</a> exposes a schema in the JSON
|
||||||
|
Hyperschema format. As a result, the Core API command line client and Python
|
||||||
|
client library can be <a href="http://www.coreapi.org/tools-and-resources/example-services/#heroku-json-hyper-schema">used to interact with the Heroku API</a>.</p>
|
||||||
|
<h2 id="client-side-core-api"><a class="toclink" href="#client-side-core-api">Client-side Core API</a></h2>
|
||||||
|
<p><a href="http://www.coreapi.org/">Core API</a> is a document specification that can be used to describe APIs. It can
|
||||||
|
be used either server-side, as is done with REST framework's <a href="../../api-guide/schemas/">schema generation</a>,
|
||||||
|
or used client-side, as described here.</p>
|
||||||
|
<p>When used client-side, Core API allows for <em>dynamically driven client libraries</em>
|
||||||
|
that can interact with any API that exposes a supported schema or hypermedia
|
||||||
|
format.</p>
|
||||||
|
<p>Using a dynamically driven client has a number of advantages over interacting
|
||||||
|
with an API by building HTTP requests directly.</p>
|
||||||
|
<h4 id="more-meaningful-interaction"><a class="toclink" href="#more-meaningful-interaction">More meaningful interaction</a></h4>
|
||||||
|
<p>API interactions are presented in a more meaningful way. You're working at
|
||||||
|
the application interface layer, rather than the network interface layer.</p>
|
||||||
|
<h4 id="resilience-evolvability"><a class="toclink" href="#resilience-evolvability">Resilience & evolvability</a></h4>
|
||||||
|
<p>The client determines what endpoints are available, what parameters exist
|
||||||
|
against each particular endpoint, and how HTTP requests are formed.</p>
|
||||||
|
<p>This also allows for a degree of API evolvability. URLs can be modified
|
||||||
|
without breaking existing clients, or more efficient encodings can be used
|
||||||
|
on-the-wire, with clients transparently upgrading.</p>
|
||||||
|
<h4 id="self-descriptive-apis"><a class="toclink" href="#self-descriptive-apis">Self-descriptive APIs</a></h4>
|
||||||
|
<p>A dynamically driven client is able to present documentation on the API to the
|
||||||
|
end user. This documentation allows the user to discover the available endpoints
|
||||||
|
and parameters, and better understand the API they are working with.</p>
|
||||||
|
<p>Because this documentation is driven by the API schema it will always be fully
|
||||||
|
up to date with the most recently deployed version of the service.</p>
|
||||||
|
<hr />
|
||||||
|
<h1 id="command-line-client"><a class="toclink" href="#command-line-client">Command line client</a></h1>
|
||||||
|
<p>The command line client allows you to inspect and interact with any API that
|
||||||
|
exposes a supported schema format.</p>
|
||||||
|
<h2 id="getting-started"><a class="toclink" href="#getting-started">Getting started</a></h2>
|
||||||
|
<p>To install the Core API command line client, use <code>pip</code>.</p>
|
||||||
|
<pre><code>$ pip install coreapi
|
||||||
|
</code></pre>
|
||||||
|
<p>To start inspecting and interacting with an API the schema must first be loaded
|
||||||
|
from the network.</p>
|
||||||
|
<pre><code>$ coreapi get http://api.example.org/
|
||||||
|
<Pastebin API "http://127.0.0.1:8000/">
|
||||||
|
snippets: {
|
||||||
|
create(code, [title], [linenos], [language], [style])
|
||||||
|
destroy(pk)
|
||||||
|
highlight(pk)
|
||||||
|
list([page])
|
||||||
|
partial_update(pk, [title], [code], [linenos], [language], [style])
|
||||||
|
retrieve(pk)
|
||||||
|
update(pk, code, [title], [linenos], [language], [style])
|
||||||
|
}
|
||||||
|
users: {
|
||||||
|
list([page])
|
||||||
|
retrieve(pk)
|
||||||
|
}
|
||||||
|
</code></pre>
|
||||||
|
<p>This will then load the schema, displaying the resulting <code>Document</code>. This
|
||||||
|
<code>Document</code> includes all the available interactions that may be made against the API.</p>
|
||||||
|
<p>To interact with the API, use the <code>action</code> command. This command requires a list
|
||||||
|
of keys that are used to index into the link.</p>
|
||||||
|
<pre><code>$ coreapi action users list
|
||||||
|
[
|
||||||
|
{
|
||||||
|
"url": "http://127.0.0.1:8000/users/2/",
|
||||||
|
"id": 2,
|
||||||
|
"username": "aziz",
|
||||||
|
"snippets": []
|
||||||
|
},
|
||||||
|
...
|
||||||
|
]
|
||||||
|
</code></pre>
|
||||||
|
<p>To inspect the underlying HTTP request and response, use the <code>--debug</code> flag.</p>
|
||||||
|
<pre><code>$ coreapi action users list --debug
|
||||||
|
> GET /users/ HTTP/1.1
|
||||||
|
> Accept: application/vnd.coreapi+json, */*
|
||||||
|
> Authorization: Basic bWF4Om1heA==
|
||||||
|
> Host: 127.0.0.1
|
||||||
|
> User-Agent: coreapi
|
||||||
|
< 200 OK
|
||||||
|
< Allow: GET, HEAD, OPTIONS
|
||||||
|
< Content-Type: application/json
|
||||||
|
< Date: Thu, 30 Jun 2016 10:51:46 GMT
|
||||||
|
< Server: WSGIServer/0.1 Python/2.7.10
|
||||||
|
< Vary: Accept, Cookie
|
||||||
|
<
|
||||||
|
< [{"url":"http://127.0.0.1/users/2/","id":2,"username":"aziz","snippets":[]},{"url":"http://127.0.0.1/users/3/","id":3,"username":"amy","snippets":["http://127.0.0.1/snippets/3/"]},{"url":"http://127.0.0.1/users/4/","id":4,"username":"max","snippets":["http://127.0.0.1/snippets/4/","http://127.0.0.1/snippets/5/","http://127.0.0.1/snippets/6/","http://127.0.0.1/snippets/7/"]},{"url":"http://127.0.0.1/users/5/","id":5,"username":"jose","snippets":[]},{"url":"http://127.0.0.1/users/6/","id":6,"username":"admin","snippets":["http://127.0.0.1/snippets/1/","http://127.0.0.1/snippets/2/"]}]
|
||||||
|
|
||||||
|
[
|
||||||
|
...
|
||||||
|
]
|
||||||
|
</code></pre>
|
||||||
|
<p>Some actions may include optional or required parameters.</p>
|
||||||
|
<pre><code>$ coreapi action users create --params username example
|
||||||
|
</code></pre>
|
||||||
|
<h2 id="authentication-headers"><a class="toclink" href="#authentication-headers">Authentication & headers</a></h2>
|
||||||
|
<p>The <code>credentials</code> command is used to manage the request <code>Authentication:</code> header.
|
||||||
|
Any credentials added are always linked to a particular domain, so as to ensure
|
||||||
|
that credentials are not leaked across differing APIs.</p>
|
||||||
|
<p>The format for adding a new credential is:</p>
|
||||||
|
<pre><code>coreapi credentials add <domain> <credentials string>
|
||||||
|
</code></pre>
|
||||||
|
<p>For instance:</p>
|
||||||
|
<pre><code>coreapi credentials add api.example.org "Token 9944b09199c62bcf9418ad846dd0e4bbdfc6ee4b"
|
||||||
|
</code></pre>
|
||||||
|
<p>The optional <code>--auth</code> flag also allows you to add specific types of authentication,
|
||||||
|
handling the encoding for you. Currently only <code>"basic"</code> is supported as an option here.
|
||||||
|
For example:</p>
|
||||||
|
<pre><code>coreapi credentials add api.example.org tomchristie:foobar --auth basic
|
||||||
|
</code></pre>
|
||||||
|
<p>You can also add specific request headers, using the <code>headers</code> command:</p>
|
||||||
|
<pre><code>coreapi headers add api.example.org x-api-version 2
|
||||||
|
</code></pre>
|
||||||
|
<p>For more information and a listing of the available subcommands use <code>coreapi
|
||||||
|
credentials --help</code> or <code>coreapi headers --help</code>.</p>
|
||||||
|
<h2 id="utilities"><a class="toclink" href="#utilities">Utilities</a></h2>
|
||||||
|
<p>The command line client includes functionality for bookmarking API URLs
|
||||||
|
under a memorable name. For example, you can add a bookmark for the
|
||||||
|
existing API, like so...</p>
|
||||||
|
<pre><code>coreapi bookmarks add accountmanagement
|
||||||
|
</code></pre>
|
||||||
|
<p>There is also functionality for navigating forward or backward through the
|
||||||
|
history of which API URLs have been accessed.</p>
|
||||||
|
<pre><code>coreapi history show
|
||||||
|
coreapi history back
|
||||||
|
</code></pre>
|
||||||
|
<p>For more information and a listing of the available subcommands use
|
||||||
|
<code>coreapi bookmarks --help</code> or <code>coreapi history --help</code>.</p>
|
||||||
|
<h2 id="other-commands"><a class="toclink" href="#other-commands">Other commands</a></h2>
|
||||||
|
<p>To display the current <code>Document</code>:</p>
|
||||||
|
<pre><code>coreapi show
|
||||||
|
</code></pre>
|
||||||
|
<p>To reload the current <code>Document</code> from the network:</p>
|
||||||
|
<pre><code>coreapi reload
|
||||||
|
</code></pre>
|
||||||
|
<p>To load a schema file from disk:</p>
|
||||||
|
<pre><code>coreapi load my-api-schema.json --format corejson
|
||||||
|
</code></pre>
|
||||||
|
<p>To remove the current document, along with all currently saved history,
|
||||||
|
credentials, headers and bookmarks:</p>
|
||||||
|
<pre><code>coreapi clear
|
||||||
|
</code></pre>
|
||||||
|
<hr />
|
||||||
|
<h1 id="python-client-library"><a class="toclink" href="#python-client-library">Python client library</a></h1>
|
||||||
|
<p>The <code>coreapi</code> Python package allows you to programatically interact with any
|
||||||
|
API that exposes a supported schema format.</p>
|
||||||
|
<h2 id="getting-started_1"><a class="toclink" href="#getting-started_1">Getting started</a></h2>
|
||||||
|
<p>You'll need to install the <code>coreapi</code> package using <code>pip</code> before you can get
|
||||||
|
started. Once you've done so, open up a python terminal.</p>
|
||||||
|
<p>In order to start working with an API, we first need a <code>Client</code> instance. The
|
||||||
|
client holds any configuration around which codecs and transports are supported
|
||||||
|
when interacting with an API, which allows you to provide for more advanced
|
||||||
|
kinds of behaviour.</p>
|
||||||
|
<pre><code>import coreapi
|
||||||
|
client = coreapi.Client()
|
||||||
|
</code></pre>
|
||||||
|
<p>Once we have a <code>Client</code> instance, we can fetch an API schema from the network.</p>
|
||||||
|
<pre><code>schema = client.get('https://api.example.org/')
|
||||||
|
</code></pre>
|
||||||
|
<p>The object returned from this call will be a <code>Document</code> instance, which is
|
||||||
|
the internal representation of the interface that we are interacting with.</p>
|
||||||
|
<p>Now that we have our schema <code>Document</code>, we can now start to interact with the API:</p>
|
||||||
|
<pre><code>users = client.action(schema, ['users', 'list'])
|
||||||
|
</code></pre>
|
||||||
|
<p>Some endpoints may include named parameters, which might be either optional or required:</p>
|
||||||
|
<pre><code>new_user = client.action(schema, ['users', 'create'], params={"username": "max"})
|
||||||
|
</code></pre>
|
||||||
|
<h2 id="codecs"><a class="toclink" href="#codecs">Codecs</a></h2>
|
||||||
|
<p>Codecs are responsible for encoding or decoding Documents.</p>
|
||||||
|
<p>The decoding process is used by a client to take a bytestring of an API schema
|
||||||
|
definition, and returning the Core API <code>Document</code> that represents that interface.</p>
|
||||||
|
<p>A codec should be associated with a particular media type, such as <strong>TODO</strong>.</p>
|
||||||
|
<p>This media type is used by the server in the response <code>Content-Type</code> header,
|
||||||
|
in order to indicate what kind of data is being returned in the response.</p>
|
||||||
|
<h4 id="configuring-codecs"><a class="toclink" href="#configuring-codecs">Configuring codecs</a></h4>
|
||||||
|
<p>The codecs that are available can be configured when instantiating a client.
|
||||||
|
The keyword argument used here is <code>decoders</code>, because in the context of a
|
||||||
|
client the codecs are only for <em>decoding</em> responses.</p>
|
||||||
|
<p>In the following example we'll configure a client to only accept <code>Core JSON</code>
|
||||||
|
and <code>JSON</code> responses. This will allow us to receive and decode a Core JSON schema,
|
||||||
|
and subsequently to receive JSON responses made against the API.</p>
|
||||||
|
<pre><code>from coreapi import codecs, Client
|
||||||
|
|
||||||
|
decoders = [codecs.CoreJSONCodec(), codecs.JSONCodec()]
|
||||||
|
client = Client(decoders=decoders)
|
||||||
|
</code></pre>
|
||||||
|
<h4 id="loading-and-saving-schemas"><a class="toclink" href="#loading-and-saving-schemas">Loading and saving schemas</a></h4>
|
||||||
|
<p>You can use a codec directly, in order to load an existing schema definition,
|
||||||
|
and return the resulting <code>Document</code>.</p>
|
||||||
|
<pre><code>schema_definition = open('my-api-schema.json', 'r').read()
|
||||||
|
codec = codecs.CoreJSONCodec()
|
||||||
|
schema = codec.load(schema_definition)
|
||||||
|
</code></pre>
|
||||||
|
<p>You can also use a codec directly to generate a schema definition given a <code>Document</code> instance:</p>
|
||||||
|
<pre><code>schema_definition = codec.dump(schema)
|
||||||
|
output_file = open('my-api-schema.json', 'r')
|
||||||
|
output_file.write(schema_definition)
|
||||||
|
</code></pre>
|
||||||
|
<h2 id="transports"><a class="toclink" href="#transports">Transports</a></h2>
|
||||||
|
<p>Transports are responsible for making network requests. The set of transports
|
||||||
|
that a client has installed determines which network protocols it is able to
|
||||||
|
support.</p>
|
||||||
|
<p>Currently the <code>coreapi</code> library only includes an HTTP/HTTPS transport, but
|
||||||
|
other protocols can also be supported.</p>
|
||||||
|
<h4 id="configuring-transports"><a class="toclink" href="#configuring-transports">Configuring transports</a></h4>
|
||||||
|
<p>The behaviour of the network layer can be customized by configuring the
|
||||||
|
transports that the client is instantiated with.</p>
|
||||||
|
<pre><code>import requests
|
||||||
|
from coreapi import transports, Client
|
||||||
|
|
||||||
|
credentials = {'api.example.org': 'Token 3bd44a009d16ff'}
|
||||||
|
transports = transports.HTTPTransport(credentials=credentials)
|
||||||
|
client = Client(transports=transports)
|
||||||
|
</code></pre>
|
||||||
|
<p>More complex customizations can also be achieved, for example modifying the
|
||||||
|
underlying <code>requests.Session</code> instance to <a href="http://docs.python-requests.org/en/master/user/advanced/#transport-adapters">attach transport adaptors</a>
|
||||||
|
that modify the outgoing requests.</p>
|
||||||
|
|
||||||
|
|
||||||
|
</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 -->
|
||||||
|
<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="https://fund.django-rest-framework.org/sidebar_include.js"></script>
|
||||||
|
<script>var base_url = '../..';</script>
|
||||||
|
<script src="../../mkdocs/js/require.js"></script>
|
||||||
|
<script src="../../js/theme.js"></script>
|
||||||
|
|
||||||
|
<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>
|
||||||
|
|
@ -199,6 +199,10 @@
|
||||||
<a href="../../api-guide/metadata/">Metadata</a>
|
<a href="../../api-guide/metadata/">Metadata</a>
|
||||||
</li>
|
</li>
|
||||||
|
|
||||||
|
<li >
|
||||||
|
<a href="../../api-guide/schemas/">Schemas</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
<li >
|
<li >
|
||||||
<a href="../../api-guide/format-suffixes/">Format suffixes</a>
|
<a href="../../api-guide/format-suffixes/">Format suffixes</a>
|
||||||
</li>
|
</li>
|
||||||
|
|
@ -234,6 +238,10 @@
|
||||||
<a href="../documenting-your-api/">Documenting your API</a>
|
<a href="../documenting-your-api/">Documenting your API</a>
|
||||||
</li>
|
</li>
|
||||||
|
|
||||||
|
<li >
|
||||||
|
<a href="../api-clients/">API Clients</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
<li >
|
<li >
|
||||||
<a href="../internationalization/">Internationalization</a>
|
<a href="../internationalization/">Internationalization</a>
|
||||||
</li>
|
</li>
|
||||||
|
|
|
||||||
|
|
@ -199,6 +199,10 @@
|
||||||
<a href="../../api-guide/metadata/">Metadata</a>
|
<a href="../../api-guide/metadata/">Metadata</a>
|
||||||
</li>
|
</li>
|
||||||
|
|
||||||
|
<li >
|
||||||
|
<a href="../../api-guide/schemas/">Schemas</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
<li >
|
<li >
|
||||||
<a href="../../api-guide/format-suffixes/">Format suffixes</a>
|
<a href="../../api-guide/format-suffixes/">Format suffixes</a>
|
||||||
</li>
|
</li>
|
||||||
|
|
@ -234,6 +238,10 @@
|
||||||
<a href="../documenting-your-api/">Documenting your API</a>
|
<a href="../documenting-your-api/">Documenting your API</a>
|
||||||
</li>
|
</li>
|
||||||
|
|
||||||
|
<li >
|
||||||
|
<a href="../api-clients/">API Clients</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
<li >
|
<li >
|
||||||
<a href="../internationalization/">Internationalization</a>
|
<a href="../internationalization/">Internationalization</a>
|
||||||
</li>
|
</li>
|
||||||
|
|
|
||||||
|
|
@ -199,6 +199,10 @@
|
||||||
<a href="../../api-guide/metadata/">Metadata</a>
|
<a href="../../api-guide/metadata/">Metadata</a>
|
||||||
</li>
|
</li>
|
||||||
|
|
||||||
|
<li >
|
||||||
|
<a href="../../api-guide/schemas/">Schemas</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
<li >
|
<li >
|
||||||
<a href="../../api-guide/format-suffixes/">Format suffixes</a>
|
<a href="../../api-guide/format-suffixes/">Format suffixes</a>
|
||||||
</li>
|
</li>
|
||||||
|
|
@ -234,6 +238,10 @@
|
||||||
<a href="../documenting-your-api/">Documenting your API</a>
|
<a href="../documenting-your-api/">Documenting your API</a>
|
||||||
</li>
|
</li>
|
||||||
|
|
||||||
|
<li >
|
||||||
|
<a href="../api-clients/">API Clients</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
<li >
|
<li >
|
||||||
<a href="../internationalization/">Internationalization</a>
|
<a href="../internationalization/">Internationalization</a>
|
||||||
</li>
|
</li>
|
||||||
|
|
|
||||||
|
|
@ -58,7 +58,7 @@
|
||||||
<div class="navbar-inner">
|
<div class="navbar-inner">
|
||||||
<div class="container-fluid">
|
<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>
|
<a class="repo-link btn btn-primary btn-small" href="https://github.com/tomchristie/django-rest-framework/tree/master">GitHub</a>
|
||||||
<a class="repo-link btn btn-inverse btn-small " rel="prev" href="../internationalization/">
|
<a class="repo-link btn btn-inverse btn-small " rel="prev" href="../api-clients/">
|
||||||
Next <i class="icon-arrow-right icon-white"></i>
|
Next <i class="icon-arrow-right icon-white"></i>
|
||||||
</a>
|
</a>
|
||||||
<a class="repo-link btn btn-inverse btn-small " rel="next" href="../../api-guide/settings/">
|
<a class="repo-link btn btn-inverse btn-small " rel="next" href="../../api-guide/settings/">
|
||||||
|
|
@ -199,6 +199,10 @@
|
||||||
<a href="../../api-guide/metadata/">Metadata</a>
|
<a href="../../api-guide/metadata/">Metadata</a>
|
||||||
</li>
|
</li>
|
||||||
|
|
||||||
|
<li >
|
||||||
|
<a href="../../api-guide/schemas/">Schemas</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
<li >
|
<li >
|
||||||
<a href="../../api-guide/format-suffixes/">Format suffixes</a>
|
<a href="../../api-guide/format-suffixes/">Format suffixes</a>
|
||||||
</li>
|
</li>
|
||||||
|
|
@ -234,6 +238,10 @@
|
||||||
<a href="./">Documenting your API</a>
|
<a href="./">Documenting your API</a>
|
||||||
</li>
|
</li>
|
||||||
|
|
||||||
|
<li >
|
||||||
|
<a href="../api-clients/">API Clients</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
<li >
|
<li >
|
||||||
<a href="../internationalization/">Internationalization</a>
|
<a href="../internationalization/">Internationalization</a>
|
||||||
</li>
|
</li>
|
||||||
|
|
|
||||||
|
|
@ -199,6 +199,10 @@
|
||||||
<a href="../../api-guide/metadata/">Metadata</a>
|
<a href="../../api-guide/metadata/">Metadata</a>
|
||||||
</li>
|
</li>
|
||||||
|
|
||||||
|
<li >
|
||||||
|
<a href="../../api-guide/schemas/">Schemas</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
<li >
|
<li >
|
||||||
<a href="../../api-guide/format-suffixes/">Format suffixes</a>
|
<a href="../../api-guide/format-suffixes/">Format suffixes</a>
|
||||||
</li>
|
</li>
|
||||||
|
|
@ -234,6 +238,10 @@
|
||||||
<a href="../documenting-your-api/">Documenting your API</a>
|
<a href="../documenting-your-api/">Documenting your API</a>
|
||||||
</li>
|
</li>
|
||||||
|
|
||||||
|
<li >
|
||||||
|
<a href="../api-clients/">API Clients</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
<li >
|
<li >
|
||||||
<a href="../internationalization/">Internationalization</a>
|
<a href="../internationalization/">Internationalization</a>
|
||||||
</li>
|
</li>
|
||||||
|
|
|
||||||
|
|
@ -199,6 +199,10 @@
|
||||||
<a href="../../api-guide/metadata/">Metadata</a>
|
<a href="../../api-guide/metadata/">Metadata</a>
|
||||||
</li>
|
</li>
|
||||||
|
|
||||||
|
<li >
|
||||||
|
<a href="../../api-guide/schemas/">Schemas</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
<li >
|
<li >
|
||||||
<a href="../../api-guide/format-suffixes/">Format suffixes</a>
|
<a href="../../api-guide/format-suffixes/">Format suffixes</a>
|
||||||
</li>
|
</li>
|
||||||
|
|
@ -234,6 +238,10 @@
|
||||||
<a href="../documenting-your-api/">Documenting your API</a>
|
<a href="../documenting-your-api/">Documenting your API</a>
|
||||||
</li>
|
</li>
|
||||||
|
|
||||||
|
<li >
|
||||||
|
<a href="../api-clients/">API Clients</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
<li >
|
<li >
|
||||||
<a href="../internationalization/">Internationalization</a>
|
<a href="../internationalization/">Internationalization</a>
|
||||||
</li>
|
</li>
|
||||||
|
|
|
||||||
|
|
@ -61,7 +61,7 @@
|
||||||
<a class="repo-link btn btn-inverse btn-small " rel="prev" href="../ajax-csrf-cors/">
|
<a class="repo-link btn btn-inverse btn-small " rel="prev" href="../ajax-csrf-cors/">
|
||||||
Next <i class="icon-arrow-right icon-white"></i>
|
Next <i class="icon-arrow-right icon-white"></i>
|
||||||
</a>
|
</a>
|
||||||
<a class="repo-link btn btn-inverse btn-small " rel="next" href="../documenting-your-api/">
|
<a class="repo-link btn btn-inverse btn-small " rel="next" href="../api-clients/">
|
||||||
<i class="icon-arrow-left icon-white"></i> Previous
|
<i class="icon-arrow-left icon-white"></i> Previous
|
||||||
</a>
|
</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 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>
|
||||||
|
|
@ -199,6 +199,10 @@
|
||||||
<a href="../../api-guide/metadata/">Metadata</a>
|
<a href="../../api-guide/metadata/">Metadata</a>
|
||||||
</li>
|
</li>
|
||||||
|
|
||||||
|
<li >
|
||||||
|
<a href="../../api-guide/schemas/">Schemas</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
<li >
|
<li >
|
||||||
<a href="../../api-guide/format-suffixes/">Format suffixes</a>
|
<a href="../../api-guide/format-suffixes/">Format suffixes</a>
|
||||||
</li>
|
</li>
|
||||||
|
|
@ -234,6 +238,10 @@
|
||||||
<a href="../documenting-your-api/">Documenting your API</a>
|
<a href="../documenting-your-api/">Documenting your API</a>
|
||||||
</li>
|
</li>
|
||||||
|
|
||||||
|
<li >
|
||||||
|
<a href="../api-clients/">API Clients</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
<li class="active" >
|
<li class="active" >
|
||||||
<a href="./">Internationalization</a>
|
<a href="./">Internationalization</a>
|
||||||
</li>
|
</li>
|
||||||
|
|
|
||||||
|
|
@ -199,6 +199,10 @@
|
||||||
<a href="../../api-guide/metadata/">Metadata</a>
|
<a href="../../api-guide/metadata/">Metadata</a>
|
||||||
</li>
|
</li>
|
||||||
|
|
||||||
|
<li >
|
||||||
|
<a href="../../api-guide/schemas/">Schemas</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
<li >
|
<li >
|
||||||
<a href="../../api-guide/format-suffixes/">Format suffixes</a>
|
<a href="../../api-guide/format-suffixes/">Format suffixes</a>
|
||||||
</li>
|
</li>
|
||||||
|
|
@ -234,6 +238,10 @@
|
||||||
<a href="../documenting-your-api/">Documenting your API</a>
|
<a href="../documenting-your-api/">Documenting your API</a>
|
||||||
</li>
|
</li>
|
||||||
|
|
||||||
|
<li >
|
||||||
|
<a href="../api-clients/">API Clients</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
<li >
|
<li >
|
||||||
<a href="../internationalization/">Internationalization</a>
|
<a href="../internationalization/">Internationalization</a>
|
||||||
</li>
|
</li>
|
||||||
|
|
|
||||||
|
|
@ -199,6 +199,10 @@
|
||||||
<a href="../../api-guide/metadata/">Metadata</a>
|
<a href="../../api-guide/metadata/">Metadata</a>
|
||||||
</li>
|
</li>
|
||||||
|
|
||||||
|
<li >
|
||||||
|
<a href="../../api-guide/schemas/">Schemas</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
<li >
|
<li >
|
||||||
<a href="../../api-guide/format-suffixes/">Format suffixes</a>
|
<a href="../../api-guide/format-suffixes/">Format suffixes</a>
|
||||||
</li>
|
</li>
|
||||||
|
|
@ -234,6 +238,10 @@
|
||||||
<a href="../documenting-your-api/">Documenting your API</a>
|
<a href="../documenting-your-api/">Documenting your API</a>
|
||||||
</li>
|
</li>
|
||||||
|
|
||||||
|
<li >
|
||||||
|
<a href="../api-clients/">API Clients</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
<li >
|
<li >
|
||||||
<a href="../internationalization/">Internationalization</a>
|
<a href="../internationalization/">Internationalization</a>
|
||||||
</li>
|
</li>
|
||||||
|
|
|
||||||
|
|
@ -199,6 +199,10 @@
|
||||||
<a href="../../api-guide/metadata/">Metadata</a>
|
<a href="../../api-guide/metadata/">Metadata</a>
|
||||||
</li>
|
</li>
|
||||||
|
|
||||||
|
<li >
|
||||||
|
<a href="../../api-guide/schemas/">Schemas</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
<li >
|
<li >
|
||||||
<a href="../../api-guide/format-suffixes/">Format suffixes</a>
|
<a href="../../api-guide/format-suffixes/">Format suffixes</a>
|
||||||
</li>
|
</li>
|
||||||
|
|
@ -234,6 +238,10 @@
|
||||||
<a href="../documenting-your-api/">Documenting your API</a>
|
<a href="../documenting-your-api/">Documenting your API</a>
|
||||||
</li>
|
</li>
|
||||||
|
|
||||||
|
<li >
|
||||||
|
<a href="../api-clients/">API Clients</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
<li >
|
<li >
|
||||||
<a href="../internationalization/">Internationalization</a>
|
<a href="../internationalization/">Internationalization</a>
|
||||||
</li>
|
</li>
|
||||||
|
|
|
||||||
|
|
@ -199,6 +199,10 @@
|
||||||
<a href="../../api-guide/metadata/">Metadata</a>
|
<a href="../../api-guide/metadata/">Metadata</a>
|
||||||
</li>
|
</li>
|
||||||
|
|
||||||
|
<li >
|
||||||
|
<a href="../../api-guide/schemas/">Schemas</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
<li >
|
<li >
|
||||||
<a href="../../api-guide/format-suffixes/">Format suffixes</a>
|
<a href="../../api-guide/format-suffixes/">Format suffixes</a>
|
||||||
</li>
|
</li>
|
||||||
|
|
@ -234,6 +238,10 @@
|
||||||
<a href="../documenting-your-api/">Documenting your API</a>
|
<a href="../documenting-your-api/">Documenting your API</a>
|
||||||
</li>
|
</li>
|
||||||
|
|
||||||
|
<li >
|
||||||
|
<a href="../api-clients/">API Clients</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
<li >
|
<li >
|
||||||
<a href="../internationalization/">Internationalization</a>
|
<a href="../internationalization/">Internationalization</a>
|
||||||
</li>
|
</li>
|
||||||
|
|
|
||||||
|
|
@ -199,6 +199,10 @@
|
||||||
<a href="../../api-guide/metadata/">Metadata</a>
|
<a href="../../api-guide/metadata/">Metadata</a>
|
||||||
</li>
|
</li>
|
||||||
|
|
||||||
|
<li >
|
||||||
|
<a href="../../api-guide/schemas/">Schemas</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
<li >
|
<li >
|
||||||
<a href="../../api-guide/format-suffixes/">Format suffixes</a>
|
<a href="../../api-guide/format-suffixes/">Format suffixes</a>
|
||||||
</li>
|
</li>
|
||||||
|
|
@ -234,6 +238,10 @@
|
||||||
<a href="../documenting-your-api/">Documenting your API</a>
|
<a href="../documenting-your-api/">Documenting your API</a>
|
||||||
</li>
|
</li>
|
||||||
|
|
||||||
|
<li >
|
||||||
|
<a href="../api-clients/">API Clients</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
<li >
|
<li >
|
||||||
<a href="../internationalization/">Internationalization</a>
|
<a href="../internationalization/">Internationalization</a>
|
||||||
</li>
|
</li>
|
||||||
|
|
|
||||||
|
|
@ -199,6 +199,10 @@
|
||||||
<a href="../../api-guide/metadata/">Metadata</a>
|
<a href="../../api-guide/metadata/">Metadata</a>
|
||||||
</li>
|
</li>
|
||||||
|
|
||||||
|
<li >
|
||||||
|
<a href="../../api-guide/schemas/">Schemas</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
<li >
|
<li >
|
||||||
<a href="../../api-guide/format-suffixes/">Format suffixes</a>
|
<a href="../../api-guide/format-suffixes/">Format suffixes</a>
|
||||||
</li>
|
</li>
|
||||||
|
|
@ -234,6 +238,10 @@
|
||||||
<a href="../documenting-your-api/">Documenting your API</a>
|
<a href="../documenting-your-api/">Documenting your API</a>
|
||||||
</li>
|
</li>
|
||||||
|
|
||||||
|
<li >
|
||||||
|
<a href="../api-clients/">API Clients</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
<li >
|
<li >
|
||||||
<a href="../internationalization/">Internationalization</a>
|
<a href="../internationalization/">Internationalization</a>
|
||||||
</li>
|
</li>
|
||||||
|
|
|
||||||
|
|
@ -199,6 +199,10 @@
|
||||||
<a href="../../api-guide/metadata/">Metadata</a>
|
<a href="../../api-guide/metadata/">Metadata</a>
|
||||||
</li>
|
</li>
|
||||||
|
|
||||||
|
<li >
|
||||||
|
<a href="../../api-guide/schemas/">Schemas</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
<li >
|
<li >
|
||||||
<a href="../../api-guide/format-suffixes/">Format suffixes</a>
|
<a href="../../api-guide/format-suffixes/">Format suffixes</a>
|
||||||
</li>
|
</li>
|
||||||
|
|
@ -234,6 +238,10 @@
|
||||||
<a href="../../topics/documenting-your-api/">Documenting your API</a>
|
<a href="../../topics/documenting-your-api/">Documenting your API</a>
|
||||||
</li>
|
</li>
|
||||||
|
|
||||||
|
<li >
|
||||||
|
<a href="../../topics/api-clients/">API Clients</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
<li >
|
<li >
|
||||||
<a href="../../topics/internationalization/">Internationalization</a>
|
<a href="../../topics/internationalization/">Internationalization</a>
|
||||||
</li>
|
</li>
|
||||||
|
|
|
||||||
|
|
@ -199,6 +199,10 @@
|
||||||
<a href="../../api-guide/metadata/">Metadata</a>
|
<a href="../../api-guide/metadata/">Metadata</a>
|
||||||
</li>
|
</li>
|
||||||
|
|
||||||
|
<li >
|
||||||
|
<a href="../../api-guide/schemas/">Schemas</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
<li >
|
<li >
|
||||||
<a href="../../api-guide/format-suffixes/">Format suffixes</a>
|
<a href="../../api-guide/format-suffixes/">Format suffixes</a>
|
||||||
</li>
|
</li>
|
||||||
|
|
@ -234,6 +238,10 @@
|
||||||
<a href="../../topics/documenting-your-api/">Documenting your API</a>
|
<a href="../../topics/documenting-your-api/">Documenting your API</a>
|
||||||
</li>
|
</li>
|
||||||
|
|
||||||
|
<li >
|
||||||
|
<a href="../../topics/api-clients/">API Clients</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
<li >
|
<li >
|
||||||
<a href="../../topics/internationalization/">Internationalization</a>
|
<a href="../../topics/internationalization/">Internationalization</a>
|
||||||
</li>
|
</li>
|
||||||
|
|
|
||||||
|
|
@ -199,6 +199,10 @@
|
||||||
<a href="../../api-guide/metadata/">Metadata</a>
|
<a href="../../api-guide/metadata/">Metadata</a>
|
||||||
</li>
|
</li>
|
||||||
|
|
||||||
|
<li >
|
||||||
|
<a href="../../api-guide/schemas/">Schemas</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
<li >
|
<li >
|
||||||
<a href="../../api-guide/format-suffixes/">Format suffixes</a>
|
<a href="../../api-guide/format-suffixes/">Format suffixes</a>
|
||||||
</li>
|
</li>
|
||||||
|
|
@ -234,6 +238,10 @@
|
||||||
<a href="../../topics/documenting-your-api/">Documenting your API</a>
|
<a href="../../topics/documenting-your-api/">Documenting your API</a>
|
||||||
</li>
|
</li>
|
||||||
|
|
||||||
|
<li >
|
||||||
|
<a href="../../topics/api-clients/">API Clients</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
<li >
|
<li >
|
||||||
<a href="../../topics/internationalization/">Internationalization</a>
|
<a href="../../topics/internationalization/">Internationalization</a>
|
||||||
</li>
|
</li>
|
||||||
|
|
|
||||||
|
|
@ -199,6 +199,10 @@
|
||||||
<a href="../../api-guide/metadata/">Metadata</a>
|
<a href="../../api-guide/metadata/">Metadata</a>
|
||||||
</li>
|
</li>
|
||||||
|
|
||||||
|
<li >
|
||||||
|
<a href="../../api-guide/schemas/">Schemas</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
<li >
|
<li >
|
||||||
<a href="../../api-guide/format-suffixes/">Format suffixes</a>
|
<a href="../../api-guide/format-suffixes/">Format suffixes</a>
|
||||||
</li>
|
</li>
|
||||||
|
|
@ -234,6 +238,10 @@
|
||||||
<a href="../../topics/documenting-your-api/">Documenting your API</a>
|
<a href="../../topics/documenting-your-api/">Documenting your API</a>
|
||||||
</li>
|
</li>
|
||||||
|
|
||||||
|
<li >
|
||||||
|
<a href="../../topics/api-clients/">API Clients</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
<li >
|
<li >
|
||||||
<a href="../../topics/internationalization/">Internationalization</a>
|
<a href="../../topics/internationalization/">Internationalization</a>
|
||||||
</li>
|
</li>
|
||||||
|
|
|
||||||
|
|
@ -199,6 +199,10 @@
|
||||||
<a href="../../api-guide/metadata/">Metadata</a>
|
<a href="../../api-guide/metadata/">Metadata</a>
|
||||||
</li>
|
</li>
|
||||||
|
|
||||||
|
<li >
|
||||||
|
<a href="../../api-guide/schemas/">Schemas</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
<li >
|
<li >
|
||||||
<a href="../../api-guide/format-suffixes/">Format suffixes</a>
|
<a href="../../api-guide/format-suffixes/">Format suffixes</a>
|
||||||
</li>
|
</li>
|
||||||
|
|
@ -234,6 +238,10 @@
|
||||||
<a href="../../topics/documenting-your-api/">Documenting your API</a>
|
<a href="../../topics/documenting-your-api/">Documenting your API</a>
|
||||||
</li>
|
</li>
|
||||||
|
|
||||||
|
<li >
|
||||||
|
<a href="../../topics/api-clients/">API Clients</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
<li >
|
<li >
|
||||||
<a href="../../topics/internationalization/">Internationalization</a>
|
<a href="../../topics/internationalization/">Internationalization</a>
|
||||||
</li>
|
</li>
|
||||||
|
|
|
||||||
|
|
@ -199,6 +199,10 @@
|
||||||
<a href="../../api-guide/metadata/">Metadata</a>
|
<a href="../../api-guide/metadata/">Metadata</a>
|
||||||
</li>
|
</li>
|
||||||
|
|
||||||
|
<li >
|
||||||
|
<a href="../../api-guide/schemas/">Schemas</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
<li >
|
<li >
|
||||||
<a href="../../api-guide/format-suffixes/">Format suffixes</a>
|
<a href="../../api-guide/format-suffixes/">Format suffixes</a>
|
||||||
</li>
|
</li>
|
||||||
|
|
@ -234,6 +238,10 @@
|
||||||
<a href="../../topics/documenting-your-api/">Documenting your API</a>
|
<a href="../../topics/documenting-your-api/">Documenting your API</a>
|
||||||
</li>
|
</li>
|
||||||
|
|
||||||
|
<li >
|
||||||
|
<a href="../../topics/api-clients/">API Clients</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
<li >
|
<li >
|
||||||
<a href="../../topics/internationalization/">Internationalization</a>
|
<a href="../../topics/internationalization/">Internationalization</a>
|
||||||
</li>
|
</li>
|
||||||
|
|
@ -496,7 +504,7 @@ urlpatterns = [
|
||||||
<p>Using viewsets can be a really useful abstraction. It helps ensure that URL conventions will be consistent across your API, minimizes the amount of code you need to write, and allows you to concentrate on the interactions and representations your API provides rather than the specifics of the URL conf.</p>
|
<p>Using viewsets can be a really useful abstraction. It helps ensure that URL conventions will be consistent across your API, minimizes the amount of code you need to write, and allows you to concentrate on the interactions and representations your API provides rather than the specifics of the URL conf.</p>
|
||||||
<p>That doesn't mean it's always the right approach to take. There's a similar set of trade-offs to consider as when using class-based views instead of function based views. Using viewsets is less explicit than building your views individually.</p>
|
<p>That doesn't mean it's always the right approach to take. There's a similar set of trade-offs to consider as when using class-based views instead of function based views. Using viewsets is less explicit than building your views individually.</p>
|
||||||
<h2 id="reviewing-our-work"><a class="toclink" href="#reviewing-our-work">Reviewing our work</a></h2>
|
<h2 id="reviewing-our-work"><a class="toclink" href="#reviewing-our-work">Reviewing our work</a></h2>
|
||||||
<p>With an incredibly small amount of code, we've now got a complete pastebin Web API, which is fully web browsable, and comes complete with authentication, per-object permissions, and multiple renderer formats.</p>
|
<p>With an incredibly small amount of code, we've now got a complete pastebin Web API, which is fully web browsable, includes a schema-driven client library, and comes complete with authentication, per-object permissions, and multiple renderer formats.</p>
|
||||||
<p>We've walked through each step of the design process, and seen how if we need to customize anything we can gradually work our way down to simply using regular Django views.</p>
|
<p>We've walked through each step of the design process, and seen how if we need to customize anything we can gradually work our way down to simply using regular Django views.</p>
|
||||||
<p>You can review the final <a href="https://github.com/tomchristie/rest-framework-tutorial">tutorial code</a> on GitHub, or try out a live example in <a href="http://restframework.herokuapp.com/">the sandbox</a>.</p>
|
<p>You can review the final <a href="https://github.com/tomchristie/rest-framework-tutorial">tutorial code</a> on GitHub, or try out a live example in <a href="http://restframework.herokuapp.com/">the sandbox</a>.</p>
|
||||||
<h2 id="onwards-and-upwards"><a class="toclink" href="#onwards-and-upwards">Onwards and upwards</a></h2>
|
<h2 id="onwards-and-upwards"><a class="toclink" href="#onwards-and-upwards">Onwards and upwards</a></h2>
|
||||||
|
|
@ -506,7 +514,6 @@ urlpatterns = [
|
||||||
<li>Join the <a href="https://groups.google.com/forum/?fromgroups#!forum/django-rest-framework">REST framework discussion group</a>, and help build the community.</li>
|
<li>Join the <a href="https://groups.google.com/forum/?fromgroups#!forum/django-rest-framework">REST framework discussion group</a>, and help build the community.</li>
|
||||||
<li>Follow <a href="https://twitter.com/_tomchristie">the author</a> on Twitter and say hi.</li>
|
<li>Follow <a href="https://twitter.com/_tomchristie">the author</a> on Twitter and say hi.</li>
|
||||||
</ul>
|
</ul>
|
||||||
<p><strong>Now go build awesome things.</strong></p>
|
|
||||||
|
|
||||||
|
|
||||||
</div> <!--/span-->
|
</div> <!--/span-->
|
||||||
|
|
|
||||||
|
|
@ -199,6 +199,10 @@
|
||||||
<a href="../../api-guide/metadata/">Metadata</a>
|
<a href="../../api-guide/metadata/">Metadata</a>
|
||||||
</li>
|
</li>
|
||||||
|
|
||||||
|
<li >
|
||||||
|
<a href="../../api-guide/schemas/">Schemas</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
<li >
|
<li >
|
||||||
<a href="../../api-guide/format-suffixes/">Format suffixes</a>
|
<a href="../../api-guide/format-suffixes/">Format suffixes</a>
|
||||||
</li>
|
</li>
|
||||||
|
|
@ -234,6 +238,10 @@
|
||||||
<a href="../../topics/documenting-your-api/">Documenting your API</a>
|
<a href="../../topics/documenting-your-api/">Documenting your API</a>
|
||||||
</li>
|
</li>
|
||||||
|
|
||||||
|
<li >
|
||||||
|
<a href="../../topics/api-clients/">API Clients</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
<li >
|
<li >
|
||||||
<a href="../../topics/internationalization/">Internationalization</a>
|
<a href="../../topics/internationalization/">Internationalization</a>
|
||||||
</li>
|
</li>
|
||||||
|
|
|
||||||
Loading…
Reference in New Issue
Block a user