api.md

account/api.md

@@ -0,0 +1,57 @@
+# account
+
+## register
+### params
+'username', 'password', 'email'
+### return
+- code=303, error='用户名/密码/邮箱不能为空'
+- code=301, error='用户名已存在'
+- code=302, error='邮箱已存在'
+- code=500, error=str(e)
+- code=200
+
+## login
+### params
+'username', 'password'
+### return
+- code=303, error='用户名或密码错误'
+- code=200, token=token
+
+## logout
+### params
+'username', 'token'
+### return
+- code=401, error='未登录'
+- code=200
+
+## send_email_verification_code
+### params
+'username', 'email'
+### return
+- code=302, error='用户不存在'
+- code=301, error='邮箱错误'
+- code=500, error='验证码发送失败'
+
+## check_token
+### params
+'username', 'token'
+### return
+- code=302, error='用户不存在'
+- code=303, error='验证码无效'
+- code=200
+
+## reset_password
+### params
+'username', 'email', 'token'
+### return
+- code=302, error='用户不存在'
+- code=301, error='邮箱错误'
+- code=500, error='验证码发送失败'
+
+## check_token
+### params
+'username', 'token'
+### return
+- code=302, error='用户不存在'
+- code=303, error='验证码无效'
+- code=200

account/views.py

@@ -111,7 +111,8 @@ def send_email_verification_code(request):
         user.send_email('ST网盘重置密码验证码', token)
         return make_json_response()
     except Exception as e:
-        return make_json_response(code=500, error=str(e))
+        print(e)
+        return make_json_response(code=500, error='验证码发送失败')
 
 
 @debug_view('username', 'token')

file/api.md

@@ -0,0 +1,28 @@
+# file
+## upload_file
+### params
+'username', 'token', 'father'
+### return
+- code=401, error='未登录'
+- code=400, error='文件不存在'
+- code=402, error='文件夹不存在'
+- code=404, error='没有上传文件的权限'
+- code=500, error='文件保存失败'
+
+## download_file
+### params
+'username', 'token', 'file_id'
+### return
+- code=401, error='未登录'
+- code=402, error='文件不存在'
+- code=404, error='没有下载文件的权限'
+- 文件
+
+## delete_file
+### params
+- 'username', 'token', 'file_id'
+### return
+- code=401, error='未登录'
+- code=402, error='文件不存在'
+- code=404, error='没有删除文件的权限'
+- code=200

file/views.py

@@ -24,7 +24,7 @@ def upload_file(request):
     try:
         file_obj = request.FILES.get('upload')
     except:
-        return make_json_response(code=401, error='文件不存在')
+        return make_json_response(code=400, error='文件不存在')
     file_type = judge_filepath(file_obj.name.split('.')[-1].lower()) if '.' in file_obj.name else ''
     update_time = timezone.now().strftime("%Y-%m-%d %H:%M:%S")
     file_size = file_obj.size
@@ -63,7 +63,7 @@ def download_file(request):
     try:
         file = File.objects.get(file_id=file_id)
     except:
-        return make_json_response(code=401, error='文件不存在')
+        return make_json_response(code=402, error='文件不存在')
     if not file.father_folder.check_permission(user=user):
         return make_json_response(code=404, error='没有下载文件的权限')
     file_name = file.file_name
@@ -84,7 +84,7 @@ def delete_file(request):
     try:
         file = File.objects.get(file_id=file_id)
     except:
-        return make_json_response(code=401, error='文件不存在')
+        return make_json_response(code=402, error='文件不存在')
     if not can_delete(user=user, f=file):
         return make_json_response(code=404, error='没有删除文件的权限')
     file.delete()

folder/api.md

@@ -0,0 +1,35 @@
+# folder
+
+## get_root_folder
+### params
+'username', 'token'
+### return
+- code=200, root_folder_id
+- code=401, error='未登录'
+
+## folder_list
+### params
+'username', 'token', 'folder_id'
+### return
+- code=401, error='未登录'
+- code=400, error='文件夹不存在'
+- code=404, error='没有权限'
+- code=200, children=[] (json列表)
+
+## add_folder
+### params
+'username', 'token', 'father_folder_id', 'folder_name'
+### return
+- code=401, error='未登录'
+- code=402, error='上级文件夹不存在'
+- code=404, error='没有权限'
+- code=200
+
+## delete_folder
+### params
+'username', 'token', 'folder_id'
+### return
+- code=401, error='未登录'
+- code=421, error='无此文件夹'
+- code=404, error='没有删除文件的权限'
+- code=200

folder/views.py

@@ -47,7 +47,7 @@ def add_folder(request):
     try:
         father_folder = Folder.objects.get(folder_id=father_folder_id)
     except:
-        return make_json_response(code=421, error='上级文件夹不存在')
+        return make_json_response(code=402, error='上级文件夹不存在')
     if not father_folder.check_permission(user=user):
         return make_json_response(code=404, error='没有权限')
     Folder.objects.create(folder_name=folder_name, father_folder=father_folder, owner=user, group=father_folder.group)

group/group.md

@@ -0,0 +1,35 @@
+# group
+
+## get_group_root_folder
+### params
+'username', 'token', 'group_id'
+### return
+- code=401, error='未登录'
+- code=403, error='群不存在'
+- code=200, root_folder_id
+
+## join_group
+### params
+'username', 'token', 'group_id'
+### return
+- code=401, error='未登录'
+- code=402, error='已在群内'
+- code=403, error='群不存在'
+- code=200
+
+## create_group
+### params
+'username', 'token', 'group_name'
+### return
+- code=401, error='未登录'
+- code=500, error='新建群失败'
+- code=200
+
+## quit_group
+### params
+'username', 'token', 'group_id'
+### return
+- code=401, error='未登录'
+- code=403, error='群不存在'
+- code=421, error='群主不可退群'
+- code=200

group/views.py

@@ -16,7 +16,7 @@ def get_group_root_folder(request):
     try:
         group = user.joined_groups.get(group_id=group_id)
     except:
-        return make_json_response(code=401, error='群不存在')
+        return make_json_response(code=403, error='群不存在')
     root_folder = group.get_root_folder()
     return make_json_response(root_folder_id=root_folder.folder_id)
 
@@ -32,7 +32,7 @@ def join_group(request):
     try:
         group = Group.objects.get(group_id=group_id)
     except:
-        return make_json_response(code=401, error='群不存在')
+        return make_json_response(code=403, error='群不存在')
     group.members.add(user)
     group.save()
     return make_json_response()
@@ -60,9 +60,9 @@ def quit_group(request):
     try:
         group = user.joined_groups.get(group_id=group_id)
     except:
-        return make_json_response(code=401, error='群不存在')
+        return make_json_response(code=403, error='群不存在')
     if group.creator == user:
-        return make_json_response(code=402, error='群主不可退群')
+        return make_json_response(code=421, error='群主不可退群')
     group.members.remove(user)
     group.save()
     return make_json_response()