您能否提出建议,在Django Rest Framework中如何组织编码样式以使端点与HTML和JSON分离?
在Flask中,我习惯于将服务Json和服务HTML的端点分开,例如:
@application.route('/api/')
def api_root():
#...
return jsonify({'data' : data})
和
@application.route('/home//', endpoint='page_template')
#...
return render_template(template, page)
因此,我可以像这样提供API:
/api/page => serve the json for the page, say for AJAX etc.
/page => serve the corresponding html page
在Django RF中,我读到ModelViewSet可以同时提供这两种服务。
所以我可以将所有东西都放在一个地方。
但是,当我在路由器上映射视图时,我希望所有端点都遵守与模型相关的路径,它们都是/api子路径。
您能否帮助建议一个好的编码实践,以使用ModelViewSet并路由与API分离的html的端点?
这是我正在研究的示例,我的疑问在评论中:
from rest_framework import viewsets
from rest_framework import generics
from rest_framework.decorators import action
from rest_framework.response import Response
from .serializers import PersonSerializer
from .models import Person
class PersonViewSet( viewsets.ModelViewSet):
queryset = Person.objects.all().order_by('name')
serializer_class = PersonSerializer
# this will return last person
# I can see it registered at: 127.0.0.1:8000/api/people/last_person/
@action(detail=False)
def last_person(self, request):
queryset = Person.objects.all().order_by('timestamp').reverse()[0]
serializer = self.get_serializer(queryset)
return Response(serializer.data)
# this will return a template:
# I can see it registered at: ../api/people/greetings : I wanted at /greetings
@action(detail=False)
def greetings(self, request):
queryset = Person.objects.all().order_by('timestamp').reverse()[0]
serializer = self.get_serializer(queryset)
return render(
request,
'myapi/greetings.html',
{
'person': serializer.data
}
)
另外,请注意我如何提供方法greetings :在这里,我重复查询集和序列化部分。 我想这样做:
def greetings(self, request):
person = self.last_person(request)
return render(
request,
'myapi/greetings.html',
{
'person': person
}
)
但这会产生错误,因为person将是一个Response对象,并且找不到将其传递给render 。
哪一种可能是避免重复事物并保持API和模板分离的良好编码风格?
在/myapi/url.py我注册了以下端点:
router = routers.DefaultRouter()
router.register(r'people', views.PersonViewSet)
app_name = 'myapi'
urlpatterns = [
path('', include(router.urls)),
]
在主url.py ,如下所示:
from django.urls import include
urlpatterns = [
path('admin/', admin.site.urls),
path('api/', include('myapi.urls')),
path('', include('myapi.urls')) # How to keep views for templates and for Json separated ??
]