1.               [
  1.                     课程介绍
  2.                 ](_index_)
    1.               [
  1.                     引入DjangoRESTframework
  2.                 ](c01-introducetodrf_index)
  5.         - 
  8.                 [
  14.                     Web应用模式
  15.                 ](c01-introducetodrf_separatedfrontendandbackend)
    1.               [
  1.                     认识RESTful
  2.                 ](c01-introducetodrf_introducetorest)
    1.               [
  1.                     RESTful设计方法
  2.                 ](c01-introducetodrf_howtodesignrest)
    1.               [
  1.                     使用Django开发REST接口
  2.                 ](c01-introducetodrf_developrestapiwithdjango)
    1.               [
  1.                     明确REST接口开发的核心任务
  2.                 ](c01-introducetodrf_coretasktodeveloprestapi)
    1.               [
  1.                     DjangoRESTframework简介
  2.                 ](c01-introducetodrf_aboutdrf)
    1.               [
  1.                     DRF工程搭建
  2.                 ](c02-drfproject_index)
  5.         - 
  8.                 [
  14.                     环境安装与配置
  15.                 ](c02-drfproject_installandconfig)
    1.               [
  1.                     见识DRF的魅力
  2.                 ](c02-drfproject_thefirstdrfprogram)
    1.               [
  1.                     Serializer序列化器
  2.                 ](c03-serializer_index)
  5.         - 
  8.                 [
  14.                     定义Serializer
  15.                 ](c03-serializer_declaring)
    1.               [
  1.                     序列化使用
  2.                 ](c03-serializer_serializing)
    1.               [
  1.                     反序列化使用
  2.                 ](c03-serializer_deserializing)
    1.               [
  1.                     模型类序列化器ModelSerializer
  2.                 ](c03-serializer_modelserializer)
    1.               [
  1.                     视图
  2.                 ](c04-view_index)
  5.         - 
  8.                 [
  14.                     Request与Response
  15.                 ](c04-view_requestandresponse)
    1.               [
  1.                     视图概览
  2.                 ](c04-view_view)
    1.               [
  1.                     视图说明
  2.                 ](c04-view_viewintroduction)
    1.               [
  1.                     视图集ViewSet
  2.                 ](c04-view_viewset)
    1.               [
  1.                     路由Router
  2.                 ](c04-view_routers)
    1.               [
  1.                     其他功能
  2.                 ](c05-components_index)
  5.         - 
  8.                 [
  14.                     认证
  15.                 ](c05-components_authentication)
    1.               [
  1.                     权限
  2.                 ](c05-components_permissions)
    1.               [
  1.                     限流
  2.                 ](c05-components_throttling)
    1.               [
  1.                     过滤
  2.                 ](c05-components_filtering)
    1.               [
  1.                     排序
  2.                 ](c05-components_ordering)
    1.               [
  1.                     分页
  2.                 ](c05-components_pagination)
    1.               [
  1.                     版本
  2.                 ](c05-components_versioning)
    1.               [
  1.                     异常处理
  2.                 ](c05-components_exceptions)
    1.               [
  1.                     自动生成接口文档
  2.                 ](c05-components_documents)
    1.           [
    2.               Published with GitBook
    3.           ](https://www.gitbook.com)

课程介绍

使用Django开发REST 接口

我们以在Django框架中使用的图书英雄案例来写一套支持图书数据增删改查的REST API接口，来理解REST API的开发。
在此案例中，前后端均发送JSON格式数据。

  1. # views.py
  3. from datetime import datetime
  5. class BooksAPIVIew(View):
  6.     """
  7.     查询所有图书、增加图书
  8.     """
  9.     def get(self, request):
  10.         """
  11.         查询所有图书
  12.         路由：GET /books/
  13.         """
  14.         queryset = BookInfo.objects.all()
  15.         book_list = []
  16.         for book in queryset:
  17.             book_list.append({
  18.                 'id': book.id,
  19.                 'btitle': book.btitle,
  20.                 'bpub_date': book.bpub_date,
  21.                 'bread': book.bread,
  22.                 'bcomment': book.bcomment,
  23.                 'image': book.image.url if book.image else ''
  24.             })
  25.         return JsonResponse(book_list, safe=False)
  27.     def post(self, request):
  28.         """
  29.         新增图书
  30.         路由：POST /books/
  31.         """
  32.         json_bytes = request.body
  33.         json_str = json_bytes.decode()
  34.         book_dict = json.loads(json_str)
  36.         # 此处详细的校验参数省略
  38.         book = BookInfo.objects.create(
  39.             btitle=book_dict.get('btitle'),
  40.             bpub_date=datetime.strptime(book_dict.get('bpub_date'), '%Y-%m-%d').date()
  41.         )
  43.         return JsonResponse({
  44.             'id': book.id,
  45.             'btitle': book.btitle,
  46.             'bpub_date': book.bpub_date,
  47.             'bread': book.bread,
  48.             'bcomment': book.bcomment,
  49.             'image': book.image.url if book.image else ''
  50.         }, status=201)
  53. class BookAPIView(View):
  54.     def get(self, request, pk):
  55.         """
  56.         获取单个图书信息
  57.         路由： GET  /books/<pk>/
  58.         """
  59.         try:
  60.             book = BookInfo.objects.get(pk=pk)
  61.         except BookInfo.DoesNotExist:
  62.             return HttpResponse(status=404)
  64.         return JsonResponse({
  65.             'id': book.id,
  66.             'btitle': book.btitle,
  67.             'bpub_date': book.bpub_date,
  68.             'bread': book.bread,
  69.             'bcomment': book.bcomment,
  70.             'image': book.image.url if book.image else ''
  71.         })
  73.     def put(self, request, pk):
  74.         """
  75.         修改图书信息
  76.         路由： PUT  /books/<pk>
  77.         """
  78.         try:
  79.             book = BookInfo.objects.get(pk=pk)
  80.         except BookInfo.DoesNotExist:
  81.             return HttpResponse(status=404)
  83.         json_bytes = request.body
  84.         json_str = json_bytes.decode()
  85.         book_dict = json.loads(json_str)
  87.         # 此处详细的校验参数省略
  89.         book.btitle = book_dict.get('btitle')
  90.         book.bpub_date = datetime.strptime(book_dict.get('bpub_date'), '%Y-%m-%d').date()
  91.         book.save()
  93.         return JsonResponse({
  94.             'id': book.id,
  95.             'btitle': book.btitle,
  96.             'bpub_date': book.bpub_date,
  97.             'bread': book.bread,
  98.             'bcomment': book.bcomment,
  99.             'image': book.image.url if book.image else ''
  100.         })
  102.     def delete(self, request, pk):
  103.         """
  104.         删除图书
  105.         路由： DELETE /books/<pk>/
  106.         """
  107.         try:
  108.             book = BookInfo.objects.get(pk=pk)
  109.         except BookInfo.DoesNotExist:
  110.             return HttpResponse(status=404)
  112.         book.delete()
  114.         return HttpResponse(status=204)
  1. # urls.py
  3. urlpatterns = [
  4.     url(r'^books/$', views.BooksAPIVIew.as_view()),
  5.     url(r'^books/(?P<pk>\d+)/$', views.BookAPIView.as_view())
  6. ]

测试

使用Postman测试上述接口
1） 获取所有图书数据
GET 方式访问 http://127.0.0.1:8000/books/， 返回状态码200，数据如下

  1. [
  2.     {
  3.         "id": 1,
  4.         "btitle": "射雕英雄传",
  5.         "bpub_date": "1980-05-01",
  6.         "bread": 12,
  7.         "bcomment": 34,
  8.         "image": ""
  9.     },
  10.     {
  11.         "id": 2,
  12.         "btitle": "天龙八部",
  13.         "bpub_date": "1986-07-24",
  14.         "bread": 36,
  15.         "bcomment": 40,
  16.         "image": ""
  17.     },
  18.     {
  19.         "id": 3,
  20.         "btitle": "笑傲江湖",
  21.         "bpub_date": "1995-12-24",
  22.         "bread": 20,
  23.         "bcomment": 80,
  24.         "image": ""
  25.     },
  26.     {
  27.         "id": 4,
  28.         "btitle": "雪山飞狐",
  29.         "bpub_date": "1987-11-11",
  30.         "bread": 58,
  31.         "bcomment": 24,
  32.         "image": ""
  33.     },
  34.     {
  35.         "id": 5,
  36.         "btitle": "西游记",
  37.         "bpub_date": "1988-01-01",
  38.         "bread": 10,
  39.         "bcomment": 10,
  40.         "image": "booktest/xiyouji.png"
  41.     },
  42.     {
  43.         "id": 6,
  44.         "btitle": "水浒传",
  45.         "bpub_date": "1992-01-01",
  46.         "bread": 10,
  47.         "bcomment": 11,
  48.         "image": ""
  49.     },
  50.     {
  51.         "id": 7,
  52.         "btitle": "红楼梦",
  53.         "bpub_date": "1990-01-01",
  54.         "bread": 0,
  55.         "bcomment": 0,
  56.         "image": ""
  57.     }
  58. ]

2）获取单一图书数据
GET 访问 http://127.0.0.1:8000/books/5/ ，返回状态码200， 数据如下

  1. {
  2.     "id": 5,
  3.     "btitle": "西游记",
  4.     "bpub_date": "1988-01-01",
  5.     "bread": 10,
  6.     "bcomment": 10,
  7.     "image": "booktest/xiyouji.png"
  8. }

GET 访问http://127.0.0.1:8000/books/100/，返回状态码404
3）新增图书数据
POST 访问http://127.0.0.1:8000/books/，发送JSON数据：

  1. {
  2.     "btitle": "三国演义",
  3.     "bpub_date": "1990-02-03"
  4. }

返回状态码201，数据如下

  1. {
  2.     "id": 8,
  3.     "btitle": "三国演义",
  4.     "bpub_date": "1990-02-03",
  5.     "bread": 0,
  6.     "bcomment": 0,
  7.     "image": ""
  8. }

4）修改图书数据
PUT 访问http://127.0.0.1:8000/books/8/，发送JSON数据：

  1. {
  2.     "btitle": "三国演义（第二版）",
  3.     "bpub_date": "1990-02-03"
  4. }

返回状态码200，数据如下

  1. {
  2.     "id": 8,
  3.     "btitle": "三国演义（第二版）",
  4.     "bpub_date": "1990-02-03",
  5.     "bread": 0,
  6.     "bcomment": 0,
  7.     "image": ""
  8. }

5）删除图书数据
DELETE 访问http://127.0.0.1:8000/books/8/，返回204状态码