更新接口封装方法

Author: defnngj

api/common.py

@@ -1,24 +1,22 @@
 from django.http import JsonResponse
 
 
-def ApiResponse(status=None, message=None, data=[]):
+def response(status=None, message=None, data=[]):
     """
     实现Api的固定格式的返回
-    :param status:
-    :param message:
-    :param data:
+    :param status: 状态码
+    :param message: 提示信息
+    :param data: 数据
     :return:
     """
     if status is None:
-        status__ = 10000
-    else:
-        status__ = 10000 + int(status)
+        status = 10200
 
     if message is None:
         message = "successful"
 
     response_dict = {
-        "status": status__,
+        "status": status,
         "message": message,
         "data": data
     }

api/views.py

@@ -6,22 +6,22 @@
 from django.contrib.auth.decorators import login_required
 from guest2.settings import BASE_DIR
 from api.models import User
-from api.common import ApiResponse
+from api.common import response
 
 
 def hello_world(request):
     """
     最简单的get请求，返回json格式返回
     """
-    return ApiResponse(200, "Welcome to API testing")
+    return response(10200, "Welcome to API testing")
 
 
 def user(request, username):
     """
     通过 URI 传参
     """
     msg = "hello, {}".format(username)
-    return ApiResponse(200, msg)
+    return response(10200, msg)
 
 
 def get_user_info(request, uid):
@@ -31,11 +31,11 @@ def get_user_info(request, uid):
     if request.method == "GET":
         user_info = {"id": 1, "name": "tom", "age": 22}
         if uid != 1:
-            return ApiResponse(101, "user id null")
+            return response(10101, "user id null")
         else:
-            return ApiResponse(200, data=user_info)
+            return response(10200, data=user_info)
     else:
-        return ApiResponse(101, "request method error")
+        return response(10101, "request method error")
 
 
 def search(request):
@@ -48,9 +48,9 @@ def search(request):
             data_list = ["selenium教程", "seleniumhq.org", "selenium环境安装"]
         else:
             data_list = []
-        return ApiResponse(200, data=data_list)
+        return response(10200, data=data_list)
     else:
-        return ApiResponse(101, "request method error")
+        return response(10101, "request method error")
 
 
 def post_login(request):
@@ -63,18 +63,18 @@ def post_login(request):
         password = request.POST('password')
 
         if username is None or password is None:
-            return ApiResponse(102, "username or passwrord is None")
+            return response(10102, "username or passwrord is None")
 
         elif username == "" or password == "":
-            return ApiResponse(103, "username or passwrord is null")
+            return response(10103, "username or passwrord is null")
 
         elif username == "admin" and password == "a123456":
-            return ApiResponse(200, "login success")
+            return response(10200, "login success")
 
         else:
-            return ApiResponse(104, "username or password error")
+            return response(10104, "username or password error")
     else:
-        return ApiResponse(101, "request method error")
+        return response(10101, "request method error")
 
 
 def post_add_user(request):
@@ -86,24 +86,24 @@ def post_add_user(request):
         try:
             data = json.loads(request.body)
         except json.decoder.JSONDecodeError:
-            return ApiResponse(105, "format error")
+            return response(10105, "format error")
 
         try:
             name = data["name"]
             age = data["age"]
             height = data["height"]
         except KeyError:
-            return ApiResponse(102, "key null")
+            return response(10102, "key null")
         else:
             if name == "":
-                return ApiResponse(103, "name null")
+                return response(10103, "name null")
             elif name == "tom":
-                return ApiResponse(104, "name exist")
+                return response(10104, "name exist")
             else:
                 data = {"name": name, "age": age, "height": height}
-                return ApiResponse(200, "add successful", data)
+                return response(10200, "add successful", data)
     else:
-        return ApiResponse(101, "request method error")
+        return response(10101, "request method error")
 
 
 def post_header(request):
@@ -114,9 +114,9 @@ def post_header(request):
     if request.method == 'POST':
         token = request.headers.get("token")
         ct = request.headers.get("Content-Type")
-        return ApiResponse(200, "header ok!", {"token": token, "Content-Type": ct})
+        return response(10200, "header ok!", {"token": token, "Content-Type": ct})
     else:
-        return ApiResponse(101, "request method error")
+        return response(10101, "request method error")
 
 
 def user(request, uid):
@@ -135,10 +135,10 @@ def user(request, uid):
         try:
             user = User.objects.get(id=uid)
         except User.DoesNotExist:
-            return ApiResponse(101, message="用户信息不存在")
+            return response(10101, message="用户信息不存在")
         else:
             user_info = model_to_dict(user)
-            return ApiResponse(200, data=user_info)
+            return response(10200, data=user_info)
 
     elif request.method == "POST":
         post = json.loads(request.body)
@@ -149,9 +149,9 @@ def user(request, 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)
+            return response(10200, "add success", user_info)
         else:
-            return ApiResponse(102, "用户id已存在")
+            return response(10102, "用户id已存在")
 
     elif request.method == "PUT":
         put = json.loads(request.body)
@@ -160,24 +160,24 @@ def user(request, uid):
         try:
             user = User.objects.get(id=uid)
         except User.DoesNotExist:
-            return ApiResponse(101, "用户信息不存在")
+            return response(10101, "用户信息不存在")
         else:
             user.name = name
             user.age = age
             user.save()
             user_info = model_to_dict(user)
-            return ApiResponse(200, "update success", user_info)
+            return response(10200, "update success", user_info)
 
     elif request.method == "DELETE":
         try:
             user = User.objects.get(id=uid)
         except User.DoesNotExist:
-            return ApiResponse(101, "用户信息不存在")
+            return response(10101, "用户信息不存在")
         else:
             user.delete()
-            return ApiResponse(200, "delete success")
+            return response(10200, "delete success")
     else:
-        return ApiResponse(101, "request method error")
+        return response(10101, "request method error")
 
 
 def user_login(request):
@@ -188,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 ApiResponse(102, "username or password null")
+            return response(10102, "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 ApiResponse(200, "login success")
+                return response(10200, "login success")
             else:
-                return ApiResponse(103, "username or password error")
+                return response(10103, "username or password error")
     else:
-        return ApiResponse(101, "request method error")
+        return response(10101, "request method error")
 
 
 @login_required
@@ -209,9 +209,9 @@ def user_login_data(request):
     """
     username = request.session.get('user', '') # 读取浏览器 session
     if username == "":
-        return ApiResponse(200, 'hello, stranger')
+        return response(10200, 'hello, stranger')
     else:
-        return ApiResponse(200, 'hello, {}'.format(username))
+        return response(10200, 'hello, {}'.format(username))
 
 
 def get_activity(request):
@@ -221,9 +221,9 @@ def get_activity(request):
     """
     if request.method == "GET":
         activity_info = {"id": 1, "name": "618抽奖活动"}
-        return ApiResponse(200, data=activity_info)
+        return response(10200, data=activity_info)
     else:
-        return ApiResponse(101, "request method error")
+        return response(10101, "request method error")
 
 
 def get_user(request):
@@ -232,9 +232,9 @@ def get_user(request):
     """
     if request.method == "GET":
         user_info = {"id": 1, "name": "张三"}
-        return ApiResponse(200, data=user_info)
+        return response(10200, data=user_info)
     else:
-        return ApiResponse(101, "request method error")
+        return response(10101, "request method error")
 
 
 def get_lucky_number(request):
@@ -246,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 ApiResponse(102, "username or password is None")
+            return response(10102, "username or password is None")
 
         elif activity_id == "" or user_id == "":
-            return ApiResponse(10103, "username or password is null")
+            return response(1010103, "username or password is null")
 
         if int(activity_id) != 1:
-            return ApiResponse(104, "activity id exist")
+            return response(10104, "activity id exist")
 
         if int(user_id) != 1:
-            return ApiResponse(105, "user id not exist")
+            return response(10105, "user id not exist")
 
         number = randint(10000, 99999)
-        return ApiResponse(200, "Lucky draw number", number)
+        return response(10200, "Lucky draw number", number)
 
     else:
-        return ApiResponse(101, "request method error")
+        return response(10101, "request method error")
 
 
 def upload_file(request):
@@ -271,9 +271,9 @@ def upload_file(request):
     if request.method == "POST":
         my_file = request.FILES.get("file", None)
         if not my_file:
-            return ApiResponse(101, "no files for upload!")
+            return response(10101, "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 ApiResponse(200, "upload success!")
+        return response(10200, "upload success!")