From 596190a638b18ede8e02d1b2e5c8064154b124dc Mon Sep 17 00:00:00 2001
From: kiritow <1362050620@qq.com>
Date: Wed, 22 Nov 2017 16:32:19 +0800
Subject: [PATCH] Update Design

---
 design.txt | 128 ++++++++++++++++++++++++++++++++++++++++++++++-------
 1 file changed, 113 insertions(+), 15 deletions(-)

diff --git a/design.txt b/design.txt
index e738b58..bdf0f29 100644
--- a/design.txt
+++ b/design.txt
@@ -46,7 +46,7 @@
 	类别名称 varchar 主键
 
 图书表(bs_book)
-	图书定义序号 varchar 主键 (考虑到有些书没有ISBN号)
+	图书定义序号 integer 主键 (考虑到有些书没有ISBN号)
 	ISBN号 varchar 主键
 	名称 varchar
 	类别 外键到bs_booktype
@@ -58,7 +58,7 @@
 		禁用: 禁止借阅这本书
 		
 图书状态表(bs_bookstatus)
-	图书实体序号 varchar 主键 (一本书可能在图书馆里有多本藏书)
+	图书实体序号 integer 主键 (一本书可能在图书馆里有多本藏书)
 	图书类别序号 外键到bs_book
 	位置 varchar (用来提示图书所在位置)
 	状态 integer (0 借出 1 丢失 2 在馆)
@@ -96,11 +96,11 @@
 	session
 
 增删改查 ： 图书类别，图书，账户
-	http://booksys.com/api/v1/install POST
+	http://booksys.com/api/v1/install POST (install.cpp)
 		POST:
 		dbaddr,dbport,dbuser,dbpass,dbname,supass
 		
-	http://booksys.com/api/v1/search?type=...&name=... GET
+	http://booksys.com/api/v1/search?type=...&name=... GET (search.cpp)
 		GET:
 		type= 0 用户 1 书籍
 		name= 用户名,书籍名称
@@ -110,7 +110,7 @@
 		GET:
 		没有参数
 	
-	http://booksys.com/api/v1/addbook POST
+	http://booksys.com/api/v1/addbook POST (addbook.cpp)
 		POST:
 		(图书定义序号自动生成)
 		isbn
@@ -124,7 +124,7 @@
 		错误:
 		权限不足,添加失败
 	
-	http://booksys.com/api/v1/editbook POST
+	http://booksys.com/api/v1/editbook POST (editbook.cpp)
 		POST:
 		book_key (唯一图书定义序号)
 		
@@ -140,21 +140,21 @@
 		错误:
 		权限不足,修改失败
 	
-	http://booksys.com/api/v1/removebook POST
+	http://booksys.com/api/v1/removebook POST (removebook.cpp)
 		POST:
 		book_key (唯一图书定义序号)
 		
 		错误:
 		当图书的任一实体处于借出状态时将不能删除图书定义.
 		
-	http://booksys.com/api/v1/addbooktype POST
+	http://booksys.com/api/v1/addbooktype POST (addbooktype.cpp)
 		POST:
 		booktype
 		
 		错误:
 		当新的类型名称发生冲突
 		
-	http://booksys.com/api/v1/editbooktype POST
+	http://booksys.com/api/v1/editbooktype POST (editbooktype.cpp)
 		POST:
 		booktype_old
 		booktype_new
@@ -165,14 +165,14 @@
 		副作用:
 		改变图书种类会引起所有与原种类相关图书的信息变更(未实现)
 	
-	http://booksys.com/api/v1/removebooktype POST
+	http://booksys.com/api/v1/removebooktype POST (removebooktype.cpp)
 		POST:
 		booktype
 		
 		错误:
 		当任一图书定义使用此定义时将不能删除图书种类
 		
-	http://booksys.com/api/v1/join POST
+	http://booksys.com/api/v1/join POST (join.cpp)
 		POST:
 		account
 		pass
@@ -183,7 +183,7 @@
 		错误:
 		账户名称重复时
 		
-	http://booksys.com/api/v1/enableuser POST
+	http://booksys.com/api/v1/enableuser POST (enableuser.cpp)
 		POST:
 		account
 		realname
@@ -195,7 +195,7 @@
 		错误:
 		内容填充错误或禁止激活.
 		
-	http://booksys.com/api/v1/login POST
+	http://booksys.com/api/v1/login POST (login.cpp)
 		POST:
 		account
 		pass
@@ -208,6 +208,104 @@
 		返回:
 		当登陆成功时绑定User到Session.
 		
-	http://booksys.com/api/v1/logout GET/POST
+	http://booksys.com/api/v1/logout GET/POST (logout.cpp)
 		
-		提示:退出登陆. 会立刻注销Session.
\ No newline at end of file
+		提示:退出登陆. 会立刻注销Session.
+		
+	http://booksys.com/api/v1/addbookobject POST (addbookobject.cpp)
+		POST:
+		class_id 图书定义序号
+		book_id 图书实体序号(可选,当有此参数时将尝试以此参数新建书籍)
+		position 藏书位置
+		status 图书状态
+		
+		错误:
+		权限不足
+		图书实体序号冲突
+		
+	http://booksys.com/api/v1/editbookobject POST
+		POST:
+		book_id_old 旧图书实体序号
+		book_id_new 新图书实体序号 (可选)
+		position_new 新藏书位置 (可选)
+		status 图书新状态
+		
+		错误:
+		权限不足
+		图书实体不存在
+		图书实体序号冲突
+	
+	http://booksys.com/api/v1/removebookobject POST
+		POST:
+		book_id 图书实体序号
+		
+		错误:
+		权限不足
+		图书实体序号不存在
+		图书已借出,不能删除实体
+		
+	http://booksys.com/api/v1/borrowbook POST
+		POST:
+		account 借阅者账户
+		book_id 图书实体序号
+		
+		错误:
+		权限不足(此API只能由图书管理员以上(等级<=2)调用)
+		图书不可借阅
+		实体不存在
+		
+	http://booksys.com/api/v1/returnbook POST
+		POST:
+		book_id 图书实体序号
+		
+		错误:
+		图书状态不允许还书(未借出等等)
+		实体不存在
+	
+	http://booksys.com/api/v1/blockuser POST (blockuser.cpp)
+		POST:
+		account 被操作用户
+		
+		提示:
+		本操作将修改用户的状态为1(禁止登陆)
+		
+		错误:
+		权限不足. 只有级别<=1的用户可以使用本API. 其中管理员只能修改自己和等级>=2的用户. 超级管理员可以修改全部账户.
+		
+	http://booksys.com/api/v1/allowuser POST (allowuser.cpp)
+		POST:
+		account 被操作用户
+		
+		提示:
+		本操作将修改用户的状态为3(正常). 注意: 若用户尚未完成身份验证,将忽视身份验证步骤.
+		
+		错误:
+		权限不足. 只有级别<=1的用户可以使用本API.其中管理员只能修改自己和等级>=2的用户. 超级管理员可以修改全部账户.
+		
+	http://booksys.com/api/v1/dashboard GET
+		GET:
+		无参数
+		
+		返回:
+		返回关于当前用户的全部信息. (Session关联)
+		
+		错误:
+		未登录
+		
+	http://booksys.com/api/v1/adminsearch POST
+		POST:
+		
+		提示:
+		管理员专用搜索
+		
+		错误:
+		权限不足. 只有管理员<=1能使用本API
+		
+	http://booksys.com/api/v1/advancedsearch POST
+		POST:
+		
+		提示:
+		
+		错误:
+		权限不足，只有<=2的用户能使用本API
+		
\ No newline at end of file