淺談django不使用restframework自定義接口與使用的區別
django可以使用restframework快速開發接口,返回前端所需要的json數據,但是有時候利用restframework開發的接口并不能滿足所有的需求,這時候就需要自己手動開發接口,也就是將需要用到的某些對象轉化為需要使用的json數據,今天記錄一下django自己定義接口的一種方法與思路
假設我們定義三張數據表,分別是問卷,問題,選項。一張問卷包含不同的問題,一個問題可以設置不同的選項,自定義的接口可以實現查看所有或單個問卷的標題與id,可以查看所有或單個問題的所屬問卷,問題標題,問卷的選項。
1.定義我們需要的模型類,并且在對應的模型類中定義對應的將對象轉化為字典的函數
from django.db import models class Questionnaire(models.Model): ’’’問卷’’’ title = models.CharField(’標題’,max_length=100) class Meta: verbose_name_plural = ’所有問卷’ def questionnaire_to_dict(self): ’’’把questionnaire對象轉化為字典’’’ return dict(questionnaire_id=self.id,title=self.title,questions=[question.question_to_dict() for question in self.questions.all()]) def __str__(self): return self.title class Question(models.Model): ’’’問題’’’ #所屬問卷 questionnaire = models.ForeignKey(Questionnaire,verbose_name=’所屬問卷’,related_name=’questions’) #問題標題 title = models.CharField(’問題’,max_length=150) #是否是多選 is_checkbox = models.BooleanField(’是否多選’,default=False,help_text=’是否是多選問題’) class Meta: verbose_name_plural = ’問題’ def question_to_dict(self): ’’’把question對象轉化為字典’’’ return dict(title=self.title,choice=[choice.choice_to_dict() for choice in self.choices.all()], is_checkbox=self.is_checkbox,questionnaire_id=self.questionnaire.id) def __str__(self): return self.title class Choice(models.Model): ’’’選項’’’ #所屬的問題 question = models.ForeignKey(Question,verbose_name=’所屬問題’,related_name=’choices’) content = models.CharField(’選項內容’,max_length=150) class Meta: verbose_name_plural = ’問題選項’ def choice_to_dict(self): ’’’把choice對象轉化為字典’’’ #選項id,選項所屬的問題id,選項內容 return dict(id=self.id,question_id=self.question.id,content=self.content) def __str__(self): return self.content
將你需要轉化為字典的字段添加進函數中,當指定外鍵時,'related_name'為指定關系名,用于反向查找,比如通過問卷查找問題,但是問卷模型類中沒有question字段,但是question類中指定questionnaire外鍵時指定了關系名related_name=’questions’所以可以通過self.questions.all()來查看當前問卷的所有問題。
2.定義類視圖
(1)定義查看所有問卷與添加問卷的類視圖
from question.models import Question,Questionnaire,Choicefrom django.http import JsonResponsefrom django.views import Viewimport jsonclass Questionnaires(View): def get(self,request): #獲取所有問卷 data = [] questionnaires = Questionnaire.objects.all() #獲取所有的問卷類 for questionnaire in questionnaires: data.append(questionnaire.questionnaire_to_dict()) return JsonResponse({’data’:data}) def post(self,request,*args,**kwargs): data = json.loads(request.body.decode()) questionnaire = Questionnaire(title=data.get(’title’)) questionnaire.save() return JsonResponse({’msg’:’success save’}) class QuestionnaireDetail(View): ’’’獲取id為questionnaire_id的問卷’’’ def get(self,request,questionnaire_id): questionnaire = Questionnaire.objects.get(id=questionnaire_id) data = questionnaire.questionnaire_to_dict() return JsonResponse(data)
這里繼承View類自己定義get方法與post方法處理請求,首先獲取到所有的問卷對象,在將每一個問卷對象通過自定義的函數轉化為字典,最后返回json數據,同樣處理post請求添加問卷時,首先獲取到問卷的標題,然后實例化一個問卷的對象,再將問卷對象保存。獲取單個問卷對象通過傳遞的id查看到指定的問卷對象,再通過自定義的函數將對象轉化為字典數據,最后返回單個問卷對象的json數據。
(2)獲取所有問題對象數據,及添加問題對象
class Questions(View): def get(self,request): #查詢所有問題 questions_set = Question.objects.all() #把question_set轉化為字典 data = [] for question in questions_set: data.append(question.question_to_dict()) #把字典數據當做json返回 return JsonResponse({’data’:data}) def post(self,request,*args,**kwargs): ’’’假設前端通過post傳過來一個json數據’’’ #把request中的json轉化為python對象 data = json.loads(request.body.decode()) #抽取數據 questionnaire_id = data.get(’questionnaire_id’) title = data.get(’title’) is_checkbox = data.get(’is_checkbox’) # 獲取questionnaire_id對應的對象 questionnaire = Questionnaire.objects.get(id=questionnaire_id) #創建Question實例 question = Question(title=title,is_checkbox=is_checkbox,questionnaire=questionnaire) question.save() #創建choice對象 choices = data.get(’choice’) for c in choices: choice = Choice() choice.content = c choice.question = question choice.save() return JsonResponse({'msg':'success save'})
通過get請求來獲取所有問題的json數據,通過post方法從前端獲取到傳遞過來的json數據,將其轉化為對象并保存。并在保存成功之后返回提示信息。
(3)通過get,put,delete處理單個問題對象
class QuestionDetail(View): def delete(self,request,question_id): question = Question.objects.get(id=question_id) question.delete() def put(self,request,question_id): #獲取前端put的數據 data = json.loads(request.body.decode()) title = data.get(’title’) #獲取question對象 question = Question.objects.get(id=question_id) question.title = title question.save() return JsonResponse({’msg’:’modify success’}) def get(self,request,question_id): question = Question.objects.get(id=question_id) data = question.question_to_dict() return JsonResponse(data)
這里難點是使用put方法修改某個對象的數據,使用put請求,將需要修改的數據寫成json格式,并把修改后的數據重新賦值給對象,然后保存。
3.配置url,調用接口
from django.conf.urls import urlfrom question.views import Questions,Questionnaires,QuestionDetail,QuestionnaireDetailurlpatterns = [ url(r’^questions/$’,Questions.as_view(),name=’questions’), url(r’^questionnaire/(?P<questionnaire_id>d+)/$’,QuestionnaireDetail.as_view(),name=’questionnaire’), url(r’^questionnaires/$’,Questionnaires.as_view(),name=’questionnaires’), url(r’^question/(?P<question_id>d+)/$’,QuestionDetail.as_view(),name=’question’),]
同樣,我們可以使用restframework來快速開發接口,下面是使用restframework來開發接口的代碼
1.創建對應的序列化類
from rest_framework import serializersfrom question.models import Question,Questionnaire,Choice class QuestionnaireSerializer(serializers.ModelSerializer): class Meta: model = Questionnaire fields = (’title’,) class QuestionSerializer(serializers.ModelSerializer): class Meta: model = Question fields = (’title’,’is_checkbox’,’questionnaire’) class ChoiceSerializer(serializers.ModelSerializer): class Meta: model = Choice fields = (’content’,’question’)
使用這些序列化類來序列化我們需要的字段
2.定義類視圖
class QuestionnaireList(APIView): def get(self,request): questionnaire = Questionnaire.objects.all() serializer = QuestionnaireSerializer(questionnaire,many=True) return Response(serializer.data) def post(self,request): serializer = QuestionnaireSerializer(data=request.data) if serializer.is_valid(): serializer.save() return Response(serializer.data) return Response(serializer.errors) class Questionnaire_Detail(APIView): def get_object(self,pk): try: return Questionnaire.objects.get(pk=pk) except Questionnaire.DoesNotExist: raise Http404 def get(self,request,pk): questionnaire = self.get_object(pk) serializer = QuestionnaireSerializer(questionnaire) return Response(serializer.data) def put(self,request,pk): questionnaire = self.get_object(pk) serializer = QuestionSerializer(questionnaire,data=request.data) if serializer.is_valid(): serializer.save() return Response(serializer.data) return Response(serializer.errors) def delete(self,request,pk): questionnaire = self.get_object(pk) questionnaire.delete() return Response(status=status.HTTP_204_NO_CONTENT) class QuestionList(APIView): def get(self,request): question = Question.objects.all() serializer = QuestionSerializer(question,many=True) return Response(serializer.data) def post(self,request): serializer = QuestionSerializer(data=request.data) if serializer.is_valid(): serializer.save() return Response(serializer.data) return Response(serializer.errors)
3.配置url
from django.conf.urls import urlfrom question.views import Questionnaire_Detail,QuestionnaireList,QuestionListurlpatterns = [ url(r’^questions/$’,QuestionList.as_view(),name=’questions’), url(r’^questionnaire/(?P<pk>d+)/$’,Questionnaire_Detail.as_view(),name=’questionnaire’), url(r’^questionnaires/$’,QuestionnaireList.as_view(),name=’questionnaires’),]
這里我只定義了獲取所有問卷,單個問卷及所有問題的類,使用restframework開發接口雖然快速,代碼易懂,但是它的缺點在于通過序列化類只能返回這個模型類本身的字段,并不能返回它所關聯的外鍵屬性的字段,要想獲取其他關聯模型類的數據就得定義另外的類視圖,那么對應的url也需要配置。但是同樣它的好處在于快速,代碼簡潔易懂,只不過是獲取不同模型類的數據需要定義不同的接口,不能像自定義接口那樣定義一個接口可以獲得其他模型類的數據。
以上這篇淺談django不使用restframework自定義接口與使用的區別就是小編分享給大家的全部內容了,希望能給大家一個參考,也希望大家多多支持好吧啦網。
相關文章: