封装接口的返回

Author: fnngj

api/common.py

@@ -0,0 +1,25 @@
+from django.http import JsonResponse
+
+
+def ApiResponse(status=None, message=None, data=[]):
+    """
+    实现Api的固定格式的返回
+    :param status:
+    :param message:
+    :param data:
+    :return:
+    """
+    if status is None:
+        status__ = 10000
+    else:
+        status__ = 10000 + int(status)
+
+    if message is None:
+        message = "successful"
+
+    response_dict = {
+        "status": status__,
+        "message": message,
+        "data": data
+    }
+    return JsonResponse(response_dict)

api/models.py

@@ -1,3 +1,9 @@
 from django.db import models
 
-# Create your models here.
+
+class User(models.Model):
+    name = models.CharField(max_length=100)
+    age = models.IntegerField()
+
+    def __str__(self):
+        return self.name

api/urls.py

@@ -11,7 +11,9 @@
     path('login', views.post_login),
     path('add_user', views.post_add_user),
     path('header', views.post_header),
-    path('phone/<int:pid>/', views.phone),
+
+    # RESTful 风格接口
+    path('user/<int:uid>/', views.user),
 
     # session 记录用户状态
     path('user_login', views.user_login),

api/views.py

@@ -1,25 +1,27 @@
 import os
 import json
 from random import randint
-from django.http import JsonResponse, HttpResponseRedirect
+from django.forms.models import model_to_dict
 from django.contrib import auth
 from django.contrib.auth.decorators import login_required
 from guest2.settings import BASE_DIR
+from api.models import User
+from api.common import ApiResponse
 
 
 def hello_world(request):
     """
     最简单的get请求，返回json格式返回
     """
-    return JsonResponse({"code": 10200, "message": "Welcome to API testing"})
+    return ApiResponse(200, "Welcome to API testing")
 
 
 def user(request, username):
     """
     通过 URI 传参
     """
     msg = "hello, {}".format(username)
-    return JsonResponse({"code": 10200, "message": msg})
+    return ApiResponse(200, msg)
 
 
 def get_user_info(request, uid):
@@ -29,12 +31,11 @@ def get_user_info(request, uid):
     if request.method == "GET":
         user_info = {"id": 1, "name": "tom", "age": 22}
         if uid != 1:
-            response = {"code": 10101, "message": "user id null"}
+            return ApiResponse(101, "user id null")
         else:
-            response = {"code": 10200, "message": "success", "data": user_info}
-        return JsonResponse(response)
+            return ApiResponse(200, data=user_info)
     else:
-        return JsonResponse({"code": 10101, "message": "request method error"})
+        return ApiResponse(101, "request method error")
 
 
 def search(request):
@@ -47,9 +48,9 @@ def search(request):
             data_list = ["selenium教程", "seleniumhq.org", "selenium环境安装"]
         else:
             data_list = []
-        return JsonResponse({"code": 10200, "message": "success", "data": data_list})
+        return ApiResponse(200, data=data_list)
     else:
-        return JsonResponse({"code": 10101, "message": "request method error"})
+        return ApiResponse(101, "request method error")
 
 
 def post_login(request):
@@ -62,19 +63,18 @@ def post_login(request):
         password = request.POST('password')
 
         if username is None or password is None:
-            response = {"code": 10102, "message": "username or passwrord is None"}
+            return ApiResponse(102, "username or passwrord is None")
 
         elif username == "" or password == "":
-            response = {"code": 10203, "message": "username or passwrord is null"}
+            return ApiResponse(103, "username or passwrord is null")
 
         elif username == "admin" and password == "a123456":
-            response = {"code": 10200, "message": "login success"}
+            return ApiResponse(200, "login success")
 
         else:
-            response = {"code": 10104, "message": "username or password error"}
-        return JsonResponse(response)
+            return ApiResponse(104, "username or password error")
     else:
-        return JsonResponse({"code": 10101, "message": "request method error"})
+        return ApiResponse(101, "request method error")
 
 
 def post_add_user(request):
@@ -86,25 +86,24 @@ def post_add_user(request):
         try:
             data = json.loads(request.body)
         except json.decoder.JSONDecodeError:
-            return JsonResponse({"code": 10105, "message": "format error"})
+            return ApiResponse(105, "format error")
 
         try:
             name = data["name"]
             age = data["age"]
             height = data["height"]
         except KeyError:
-            response = {"code": 10102, "message": "key null"}
+            return ApiResponse(102, "key null")
         else:
             if name == "":
-                response = {"code": 10103, "message": "name null"}
+                return ApiResponse(103, "name null")
             elif name == "tom":
-                response = {"code": 10104, "message": "name exist"}
+                return ApiResponse(104, "name exist")
             else:
                 data = {"name": name, "age": age, "height": height}
-                response = {"code": 10200, "message": "add success", "data": data}
-        return JsonResponse(response)
+                return ApiResponse(200, "add successful", data)
     else:
-        return JsonResponse({"code": 10101, "message": "request method error"})
+        return ApiResponse(101, "request method error")
 
 
 def post_header(request):
@@ -115,67 +114,70 @@ def post_header(request):
     if request.method == 'POST':
         token = request.headers.get("token")
         ct = request.headers.get("Content-Type")
-        response = {"code": 10200, "message": "header ok!",
-                    "data": {"token": token, "Content-Type": ct}}
-        return JsonResponse(response)
+        return ApiResponse(200, "header ok!", {"token": token, "Content-Type": ct})
     else:
-        return JsonResponse({"code": 10101, "message": "request method error"})
+        return ApiResponse(101, "request method error")
 
 
-def phone(request, pid):
+def user(request, uid):
     """
-    一个URL, 根据不同的方法做不同的处理
+    RESTful 风格的接口实现
+    实现用户的查询、添加、更新和删除
+    /event/1/  = GET
+    /event/2/  = POST
+    /event/1/  = PUT
+    /event/1/  = DELETE
+    :param request:
+    :param uid:
+    :return:
     """
-    # 获取数据
-    if request.method == 'GET':
-        if pid == 1:
-            phone_info = {
-                "id": pid,
-                "name": "小米手机",
-                "price": 1999
-            }
-            response = {"code": 10201, "message": "get success", "data": phone_info}
+    if request.method == "GET":
+        try:
+            user = User.objects.get(id=uid)
+        except User.DoesNotExist:
+            return ApiResponse(101, message="用户信息不存在")
         else:
-            response = {"code": 10101, "message": "The phone id is empty"}
-        return JsonResponse(response)
+            user_info = model_to_dict(user)
+            return ApiResponse(200, data=user_info)
 
-    # 添加数据
     elif request.method == "POST":
-        if pid != 1:
-            name = request.POST.get('name')
-            price = request.POST.get('price')
-            phone_info = {
-                "id": pid,
-                "name": name,
-                "price": price
-            }
-            response = {"code": 10202, "message": "add success", "data": phone_info}
+        post = json.loads(request.body)
+        name = post.get("name")
+        age = post.get("age")
+        try:
+            User.objects.get(id=uid)
+        except User.DoesNotExist:
+            user = User.objects.create(id=uid, name=name, age=age)
+            user_info = model_to_dict(user)
+            return ApiResponse(200, "add success", user_info)
         else:
-            response = {"code": 10102, "message": "The pid already exists"}
-        return JsonResponse(response)
+            return ApiResponse(102, "用户id已存在")
 
-    # 更新数据
     elif request.method == "PUT":
-        if pid == 1:
-            name = request.GET.get('name')
-            price = request.GET.get('price')
-            phone_info = {
-                "id": pid,
-                "name": name,
-                "price": price
-            }
-            response = {"code": 10203, "message": "update success", "data": phone_info}
+        put = json.loads(request.body)
+        name = put.get("name")
+        age = put.get("age")
+        try:
+            user = User.objects.get(id=uid)
+        except User.DoesNotExist:
+            return ApiResponse(101, "用户信息不存在")
         else:
-            response = {"code": 10103, "message": "The updated phone id is empty"}
-        return JsonResponse(response)
+            user.name = name
+            user.age = age
+            user.save()
+            user_info = model_to_dict(user)
+            return ApiResponse(200, "update success", user_info)
 
-    # 删除数据
     elif request.method == "DELETE":
-        if pid == 1:
-            response = {"code": 10204, "message": "delete success"}
+        try:
+            user = User.objects.get(id=uid)
+        except User.DoesNotExist:
+            return ApiResponse(101, "用户信息不存在")
         else:
-            response = {"code": 10104, "message": "The deleted phone id is empty"}
-        return JsonResponse(response)
+            user.delete()
+            return ApiResponse(200, "delete success")
+    else:
+        return ApiResponse(101, "request method error")
 
 
 def user_login(request):
@@ -186,18 +188,18 @@ def user_login(request):
         login_username = request.POST.get("username")
         login_password = request.POST.get("password")
         if login_username == '' or login_password == '':
-            return JsonResponse({"code": 10201, "message":"username or password null"})
+            return ApiResponse(102, "username or password null")
         else:
             user = auth.authenticate(username=login_username, password=login_password)
             if user is not None:
                 auth.login(request, user)
                 # 将 session 信息记录到浏览器
                 request.session['user'] = login_username
-                return JsonResponse({"code": 10200, "message": "login success"})
+                return ApiResponse(200, "login success")
             else:
-                return JsonResponse({"code": 10202, "message": "username or password error"})
+                return ApiResponse(103, "username or password error")
     else:
-        return JsonResponse({"code": 10100, "message": "Request method error"})
+        return ApiResponse(101, "request method error")
 
 
 @login_required
@@ -207,9 +209,9 @@ def user_login_data(request):
     """
     username = request.session.get('user', '') # 读取浏览器 session
     if username == "":
-        return JsonResponse({"code": 10200, "message": 'hello, stranger'})
+        return ApiResponse(200, 'hello, stranger')
     else:
-        return JsonResponse({"code": 10200, "message": 'hello, {}'.format(username)})
+        return ApiResponse(200, 'hello, {}'.format(username))
 
 
 def get_activity(request):
@@ -219,9 +221,9 @@ def get_activity(request):
     """
     if request.method == "GET":
         activity_info = {"id": 1, "name": "618抽奖活动"}
-        return JsonResponse({"code": 10200, "message": "success", "data": activity_info})
+        return ApiResponse(200, data=activity_info)
     else:
-        return JsonResponse({"code": 10101, "message": "request method error"})
+        return ApiResponse(101, "request method error")
 
 
 def get_user(request):
@@ -230,9 +232,9 @@ def get_user(request):
     """
     if request.method == "GET":
         user_info = {"id": 1, "name": "张三"}
-        return JsonResponse({"code": 10200, "message": "success", "data": user_info})
+        return ApiResponse(200, data=user_info)
     else:
-        return JsonResponse({"code": 10101, "message": "request method error"})
+        return ApiResponse(101, "request method error")
 
 
 def get_lucky_number(request):
@@ -244,22 +246,22 @@ def get_lucky_number(request):
         user_id = request.form.get('uid')
 
         if activity_id is None or user_id is None:
-            return JsonResponse({"code": 10102, "message": "username or password is None"})
+            return ApiResponse(102, "username or password is None")
 
         elif activity_id == "" or user_id == "":
-            return JsonResponse({"code": 10103, "message": "username or password is null"})
+            return ApiResponse(10103, "username or password is null")
 
         if int(activity_id) != 1:
-            return JsonResponse({"code": 10104, "message": "activity id exist"})
+            return ApiResponse(104, "activity id exist")
 
         if int(user_id) != 1:
-            return JsonResponse({"code": 10105, "message": "user id not exist"})
+            return ApiResponse(105, "user id not exist")
 
         number = randint(10000, 99999)
-        return JsonResponse({"code": 10200, "message": "Lucky draw number", "data": number})
+        return ApiResponse(200, "Lucky draw number", number)
 
     else:
-        return JsonResponse({"code": 10101, "message": "request method error"})
+        return ApiResponse(101, "request method error")
 
 
 def upload_file(request):
@@ -269,9 +271,9 @@ def upload_file(request):
     if request.method == "POST":
         my_file = request.FILES.get("file", None)
         if not my_file:
-            return JsonResponse({"code": 10101, "message": "no files for upload!"})
+            return ApiResponse(101, "no files for upload!")
         destination = open(os.path.join(BASE_DIR, "api/upload", my_file.name), 'wb+')
         for chunk in my_file.chunks():
             destination.write(chunk)
         destination.close()
-        return JsonResponse({"code": 10200, "message": "upload success!"})
+        return ApiResponse(200, "upload success!")