From fa59d60195e0ec7bb6e39083e20158db86b56667 Mon Sep 17 00:00:00 2001
From: hjd <hjd91940614@gmail.com>
Date: Sun, 15 Nov 2015 14:30:30 +0800
Subject: [PATCH] add api README.md and dabase README.md

---
 doc/api/README.md           | 243 ++++++++++++++++++++++++++++++++++++
 doc/api/安全信息检查管理.md |   0
 doc/database/README.md      |  54 ++++++++
 doc/启动说明.txt            |   4 +
 4 files changed, 301 insertions(+)
 create mode 100644 doc/api/README.md
 delete mode 100644 doc/api/安全信息检查管理.md
 create mode 100644 doc/database/README.md

diff --git a/doc/api/README.md b/doc/api/README.md
new file mode 100644
index 0000000..a2d9c04
--- /dev/null
+++ b/doc/api/README.md
@@ -0,0 +1,243 @@
+## 安全检查信息管理服务器接口文档
+##
+
+### 目录
+1. 介绍
+1. 接口描述
+1. 安全检查信息管理接口
+1. 服务器接口调用错误码
+1. 附录
+
+##
+### 介绍
+安全检查信息管理服务器后台采用jfinal,数据库采用mysql,客户端与服务器之间数据传递格式采用json。
+
+##
+### 接口描述
+- 接口使用时，将调用地址中的BaseUrl替换成IP地址或域名+端口地址(默认为80)。
+- 接口调用成功时返回JSONObject对象。
+- 接口调用可用GET或POST方法,当使用POST方法时,需要传递JSONObject对象的body。
+- JSONObject对象数据结构如下：
+<pre>
+{
+	report_name:"AH-H001-01 2015年3月11日18点测试表",
+	report_creator:"黄金定",
+	report_crete_time:"2015-11-14 11:46:10",
+	contents:
+	[{
+		No:"1",
+		content:"劳动防护用品",
+		items:
+		[{
+			item:"1.1按规定穿戴安全帽、工作服、劳保鞋等劳保用品，并保持整洁",
+			passed："1",
+			note:"",
+			picUrl:""
+		}]
+			
+	},
+	{
+		No:"2",
+		content:"防雷防静电",
+		items:
+		[{
+			item:"2.1按规定进行防雷防静电检测，并提供检测记录",
+			passed："1",
+			note:"",
+			picUrl:""
+		},
+		{
+			item:"2.2接地线、网无破损、断裂",
+			passed："1",
+			note:"",
+			picUrl:""
+		}
+		]
+			
+	}
+}
+</pre>
+
+##
+### 安全检查信息查询
+	GET http://BaseUrl/report/query?report_id=1
+
+#### 请求参数说明
+属性			|类型		 |约束		  | 说明
+------------|------------|------------|------------
+report_id 	|String		 |必选		  | 信息表的id
+
+#### 响应参数说明
+属性			|类型		 |约束		  | 说明
+------------|------------|------------|------------
+report_name |String		 |必有		  | 信息表的名字
+report_creator |String		 |必有		  | 信息表的创建者
+report_create_time |String		 |必有		  | 信息表的创建时间
+contents |Object		 |必有		  | 信息表的检查内容
+No |String		 |必有		  | 信息表的检查内容的序号
+content |String		 |必有		  | 信息表的检查内容的名字
+items |String		 |必有		  | 信息表的一个检查内容的所有检查项
+item |String		 |必有		  | 信息表的检查项
+passed |String		 |必有		  | 信息表的检查项是否通过，0 为未通过，1 未通过
+note |String		 |必有		  | 信息表的检查项备注，空字符串表示没有
+picUrl |String		 |必有		  | 信息表的检查项图片，空字符串表示没有
+
+#### 响应成功的结果示例
+
+	{
+		report_name:"AH-H001-01 2015年3月11日18点测试表",
+		report_creator:"黄金定",
+		report_crete_time:"2015-11-14 11:46:10",
+		contents:
+		[{
+			No:"1",
+			content:"劳动防护用品",
+			items:
+			[{
+				item:"1.1按规定穿戴安全帽、工作服、劳保鞋等劳保用品，并保持整洁",
+				passed："1",
+				note:"",
+				picUrl:""
+			}]
+				
+		},
+		{
+			No:"2",
+			content:"防雷防静电",
+			items:
+			[{
+				item:"2.1按规定进行防雷防静电检测，并提供检测记录",
+				passed："1",
+				note:"",
+				picUrl:""
+			},
+			{
+				item:"2.2接地线、网无破损、断裂",
+				passed："1",
+				note:"",
+				picUrl:""
+			}
+			]
+				
+		}
+	}
+
+##
+### 安全检查信息录入
+	POST http://BaseUrl/report/update?type=add
+
+#### 请求参数说明
+属性			|类型		 |约束		  | 说明
+------------|------------|------------|------------
+report_name |String		 |必有		  | 信息表的名字
+report_creator |String		 |必有		  | 信息表的创建者
+report_create_time |String		 |必有		  | 信息表的创建时间
+contents |Object		 |必有		  | 信息表的检查内容
+No |String		 |必有		  | 信息表的检查内容的序号
+content |String		 |必有		  | 信息表的检查内容的名字
+items |String		 |必有		  | 信息表的一个检查内容的所有检查项
+item |String		 |必有		  | 信息表的检查项
+passed |String		 |必有		  | 信息表的检查项是否通过，0 为未通过，1 未通过
+note |String		 |必有		  | 信息表的检查项备注，空字符串表示没有
+picUrl |String		 |必有		  | 信息表的检查项图片，空字符串表示没有
+
+#### 请求body示例
+	{
+			report_name:"AH-H001-01 2015年3月11日18点测试表",
+			report_creator:"黄金定",
+			report_crete_time:"2015-11-14 11:46:10",
+			contents:
+			[{
+				No:"1",
+				content:"劳动防护用品",
+				items:
+				[{
+					item:"1.1按规定穿戴安全帽、工作服、劳保鞋等劳保用品，并保持整洁",
+					passed："1",
+					note:"",
+					picUrl:""
+				}]
+					
+			},
+			{
+				No:"2",
+				content:"防雷防静电",
+				items:
+				[{
+					item:"2.1按规定进行防雷防静电检测，并提供检测记录",
+					passed："1",
+					note:"",
+					picUrl:""
+				},
+				{
+					item:"2.2接地线、网无破损、断裂",
+					passed："1",
+					note:"",
+					picUrl:""
+				}
+				]
+					
+			}
+		}
+
+
+#### 响应参数说明
+属性			|类型		 |约束		  | 说明
+------------|------------|------------|------------
+status 	|String		 |必选		  | 信息表的操作的状态，SUCCESS或FAILED
+
+#### 响应成功的结果示例
+	{
+		status : "SUCCESS"
+	}
+
+##
+### 安全检查信息删除
+	GET http://BaseUrl/report/query?type=delete&report_id=1
+
+#### 请求参数说明
+属性			|类型		 |约束		  | 说明
+------------|------------|------------|------------
+type 	|String		 |必选		  | 信息表的操作的类型,此处为delete
+report_id 	|String		 |必选		  | 信息表的id
+
+#### 响应参数说明
+属性			|类型		 |约束		  | 说明
+------------|------------|------------|------------
+status 	|String		 |必选		  | 信息表的操作的状态，SUCCESS或FAILED
+
+#### 响应成功的结果示例
+	{
+		status : "SUCCESS"
+	}
+
+##
+### 安全检查信息修改
+	POST http://BaseUrl/report/update?type=edit&report_id=1
+
+#### 请求参数说明
+属性			|类型		 |约束		  | 说明
+------------|------------|------------|------------
+report_name |String		 |必有		  | 信息表的名字
+report_creator |String		 |必有		  | 信息表的创建者
+report_create_time |String		 |必有		  | 信息表的创建时间
+contents |Object		 |必有		  | 信息表的检查内容
+No |String		 |必有		  | 信息表的检查内容的序号
+content |String		 |必有		  | 信息表的检查内容的名字
+items |String		 |必有		  | 信息表的一个检查内容的所有检查项
+item |String		 |必有		  | 信息表的检查项
+passed |String		 |必有		  | 信息表的检查项是否通过，0 为未通过，1 未通过
+note |String		 |必有		  | 信息表的检查项备注，空字符串表示没有
+picUrl |String		 |必有		  | 信息表的检查项图片，空字符串表示没有
+report_id 	|String		 |必选		  | 信息表的id
+type 	|String		 |必选		  | 信息表的操作的类型,此处为edit
+
+#### 响应参数说明
+属性			|类型		 |约束		  | 说明
+------------|------------|------------|------------
+status 	|String		 |必选		  | 信息表的操作的状态，SUCCESS或FAILED
+
+#### 响应成功的结果示例
+	{
+		status : "SUCCESS"
+	}
\ No newline at end of file
diff --git a/doc/api/安全信息检查管理.md b/doc/api/安全信息检查管理.md
deleted file mode 100644
index e69de29..0000000
diff --git a/doc/database/README.md b/doc/database/README.md
new file mode 100644
index 0000000..95da985
--- /dev/null
+++ b/doc/database/README.md
@@ -0,0 +1,54 @@
+## 安全检查信息管理模块数据库设计文档
+##
+
+### 目录
+1.	介绍
+1.	数据库详细设计
+1.	附录
+
+## 
+###　介绍
+安全检查信息管理模块数据库采用mysql。
+
+## 
+###　数据库详细设计
+
+#### 检查内容表 check_content
+字段			|类型		 |约束		  | 说明
+------------|------------|------------|------------
+report_content_id 	|int（11）		 |主键		  | 检查内容的id
+report_content 	|varchar（200）		 |	无	  | 检查内容
+
+#### 检查项表 check_item
+字段			|类型		 |约束		  | 说明
+------------|------------|------------|------------
+report_item 	|varchar（200）	 |主键		  | 检查项
+table_sequence 	|int（11）		 |	无	  | 所在检查内容中具体序号
+check_content_id 	|int（11）		 |	无	  | 所属检查内容的id
+
+#### 检查记录表 check_record
+字段			|类型		 |约束		  | 说明
+------------|------------|------------|------------
+repord_id 	|int（11）	 |主键		  | 检查记录id
+report_id 	|int（11）	 |无		  | 安全检查表id
+check_item 	|varchar（200）	 |无		  | 检查项
+passed 	|varchar（1）	 |无		  | 检查项是否通过，1 为通过， 0 为未通过
+pic_url 	|varchar（200）	 |无		  | 检查项图片url
+note 	|varchar（200）	 |无		  | 检查项备注
+
+#### 安全检查信息表 report
+字段			|类型		 |约束		  | 说明
+------------|------------|------------|------------
+report_id 	|int（11）	 |主键		  | 安全检查表id
+report_name 	|varchar（200）	 |无		  | 安全检查表名字
+report_creator 	|varchar（200）	 |无		  | 安全检查表创建者
+report_create_time 	|varchar（19）	 |无		  | 安全检查表创建时间
+
+#### 备注(个人时间原因)
+1.	所有表的字段的非主键约束未标注，DDL中已注明（jinshan.sql）。
+1.	关于check_item表，可以优化，具体为新增一个check_item_id字段并增加响应的约束。
+
+## 
+###　附录
+
+#### mysql文件已转储为jinshan.sql，导入即可使用。
\ No newline at end of file
diff --git a/doc/启动说明.txt b/doc/启动说明.txt
index c15d8ff..90ab6ab 100644
--- a/doc/启动说明.txt
+++ b/doc/启动说明.txt
@@ -16,5 +16,9 @@
 
 5: 打开浏览器输入  localhost 即可查看运行效果
 
+6: 服务器借口文档 及 数据库设计文档 已放入对应文件夹中，请自行查看。（*.md格式为markdown文件，可下载markdownpad2方便查看）。
+
+7: 项目已托管在github上，www.github.com/kissxiaohai/jinshan 
+
 注意： 请确保您安装了 JavaSE 1.6 或更高版本，tomcat下运行项目需要先删除 jetty-server-xxx.jar，否则会有冲突