REST framework is suitable for returning both API style responses, and regular HTML pages. Additionally, serializers can used as HTML forms and rendered in templates.
REST framework is suitable for returning both API style responses, and regular HTML pages. Additionally, serializers can used as HTML forms and rendered in templates.
## Rendering HTML
## Rendering HTML
In order to return HTML responses you'll need to either `TemplateHTMLRenderer`, or `StaticHTMLRenderer`.
In order to return HTML responses you'll need to either `TemplateHTMLRenderer`, or `StaticHTMLRenderer`.
The `TemplateHTMLRenderer` class expects the response to contain a dictionary of context data, and renders an HTML page based on a template that must be specified either in the view or on the response.
The `TemplateHTMLRenderer` class expects the response to contain a dictionary of context data, and renders an HTML page based on a template that must be specified either in the view or on the response.
The `StaticHTMLRender` class expects the response to contain a string of the pre-rendered HTML content.
The `StaticHTMLRender` class expects the response to contain a string of the pre-rendered HTML content.
Because static HTML pages typically have different behavior from API responses you'll probably need to write any HTML views explicitly, rather than relying on the built-in generic views.
Because static HTML pages typically have different behavior from API responses you'll probably need to write any HTML views explicitly, rather than relying on the built-in generic views.
Here's an example of a view that returns a list of "Profile" instances, rendered in an HTML template:
Here's an example of a view that returns a list of "Profile" instances, rendered in an HTML template:
**views.py**:
**views.py**:
from my_project.example.models import Profile
from my_project.example.models import Profile
from rest_framework.renderers import TemplateHTMLRenderer
from rest_framework.renderers import TemplateHTMLRenderer
from rest_framework.response import Response
from rest_framework.response import Response
from rest_framework.views import APIView
from rest_framework.views import APIView
class ProfileList(APIView):
class ProfileList(APIView):
renderer_classes = [TemplateHTMLRenderer]
renderer_classes = [TemplateHTMLRenderer]
template_name = 'profile_list.html'
template_name = 'profile_list.html'
def get(self, request):
def get(self, request):
queryset = Profile.objects.all()
queryset = Profile.objects.all()
return Response({'profiles': queryset})
return Response({'profiles': queryset})
**profile_list.html**:
**profile_list.html**:
<html><body>
<html><body>
<h1>Profiles</h1>
<h1>Profiles</h1>
<ul>
<ul>
{% for profile in profiles %}
{% for profile in profiles %}
<li>{{ profile.name }}</li>
<li>{{ profile.name }}</li>
{% endfor %}
{% endfor %}
</ul>
</ul>
</body></html>
</body></html>
## Rendering Forms
## Rendering Forms
Serializers may be rendered as forms by using the `render_form` template tag, and including the serializer instance as context to the template.
Serializers may be rendered as forms by using the `render_form` template tag, and including the serializer instance as context to the template.
The following view demonstrates an example of using a serializer in a template for viewing and updating a model instance:
The following view demonstrates an example of using a serializer in a template for viewing and updating a model instance:
**views.py**:
**views.py**:
from django.shortcuts import get_object_or_404
from django.shortcuts import get_object_or_404
from my_project.example.models import Profile
from my_project.example.models import Profile
from rest_framework.renderers import TemplateHTMLRenderer
from rest_framework.renderers import TemplateHTMLRenderer
The `render_form` tag takes an optional `template_pack` argument, that specifies which template directory should be used for rendering the form and form fields.
The `render_form` tag takes an optional `template_pack` argument, that specifies which template directory should be used for rendering the form and form fields.
REST framework includes three built-in template packs, all based on Bootstrap 3. The built-in styles are `horizontal`, `vertical`, and `inline`. The default style is `horizontal`. To use any of these template packs you'll want to also include the Bootstrap 3 CSS.
REST framework includes three built-in template packs, all based on Bootstrap 3. The built-in styles are `horizontal`, `vertical`, and `inline`. The default style is `horizontal`. To use any of these template packs you'll want to also include the Bootstrap 3 CSS.
The following HTML will link to a CDN hosted version of the Bootstrap 3 CSS:
The following HTML will link to a CDN hosted version of the Bootstrap 3 CSS:
Third party packages may include alternate template packs, by bundling a template directory containing the necessary form and field templates.
Third party packages may include alternate template packs, by bundling a template directory containing the necessary form and field templates.
Let's take a look at how to render each of the three available template packs. For these examples we'll use a single serializer class to present a "Login" form.
Let's take a look at how to render each of the three available template packs. For these examples we'll use a single serializer class to present a "Login" form.
Serializer fields can have their rendering style customized by using the `style` keyword argument. This argument is a dictionary of options that control the template and layout used.
The most common way to customize the field style is to use the `base_template` style keyword argument to select which template in the template pack should be use.
## Field styles
For example, to render a `CharField` as an HTML textarea rather than the default HTML input, you would use something like this:
Serializer fields can have their rendering style customized by using the `style` keyword argument. This argument is a dictionary of options that control the template and layout used.
details = serializers.CharField(
The most common way to customize the field style is to use the `base_template` style keyword argument to select which template in the template pack should be use.
max_length=1000,
style={'base_template': 'textarea.html'}
For example, to render a `CharField` as an HTML textarea rather than the default HTML input, you would use something like this:
)
details = serializers.CharField(
If you instead want a field to be rendered using a custom template that is *not part of an included template pack*, you can instead use the `template` style option, to fully specify a template name:
If you instead want a field to be rendered using a custom template that is *not part of an included template pack*, you can instead use the `template` style option, to fully specify a template name:
)
details = serializers.CharField(
Field templates can also use additional style properties, depending on their type. For example, the `textarea.html` template also accepts a `rows` property that can be used to affect the sizing of the control.
Field templates can also use additional style properties, depending on their type. For example, the `textarea.html` template also accepts a `rows` property that can be used to affect the sizing of the control.
)
details = serializers.CharField(
The complete list of `base_template` options and their associated style options is listed below.
