# 接口文档管理系统

**Repository Path**: hsh2017/docmanager

## Basic Information

- **Project Name**: 接口文档管理系统
- **Description**: 本系统是一个开源API接口文档管理系统， 本系统将原来用word编写API文档流程中解放出来，只需要按照填写文本框即可生成接口文档，管理文档也很轻松，API接口也可以一键导出word文档让你既可以在线分权限分享也可线下分享，是中小企业IT团队开发的福音。
- **Primary Language**: Java
- **License**: GPL-2.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 257
- **Forks**: 96
- **Created**: 2017-08-30
- **Last Updated**: 2024-09-20

## Categories & Tags

**Categories**: doc-tools

**Tags**: None

## README

# 接口文档管理系统

## 1. 项目介绍

本系统是一个开源API接口文档管理系统， 本系统将原来用word编写API文档流程中解放出来，只需要按照填写文本框即可生成接口文档，管理文档也很轻松，API接口也可以一键导出word文档让你既可以在线分权限分享也可线下分享，是中小企业IT团队开发的福音。

## 2. 使用说明

### 2.1 项目管理

- **项目管理页面**  

用户登录成功后首先进入“项目管理”页面，用户可以查看项目信息、修改项目信息和新增项目信息。
<a target="_blank" href="http://www.gatherlife.cn/images/docmanager/1.png"><img src="http://www.gatherlife.cn/images/docmanager/1.png"></a>

- **新增项目信息**  

用户在“项目管理”页面，点击“新增项目”按钮，看到这个页面后：
<a target="_blank" href="http://www.gatherlife.cn/images/docmanager/2.png"><img src="http://www.gatherlife.cn/images/docmanager/2.png"></a>
填写项目基本信息，点击“提交”按钮保存数据，点击“返回”按钮返回“项目管理”页面。

- **编辑项目信息** 
 
用户在“项目管理”页面，点击列表中某个项目的“编辑”操作按钮，看到这个页面后：
<a target="_blank" href="http://www.gatherlife.cn/images/docmanager/3.png"><img src="http://www.gatherlife.cn/images/docmanager/3.png"></a>
修改项目基本信息，点击“提交”按钮修改数据，点击“返回”按钮返回“项目管理”页面。

- **接口信息列表**  

用户在“项目管理”页面，点击列表中某个项目的“查看”操作按钮，看到这个页面后：
<a target="_blank" href="http://www.gatherlife.cn/images/docmanager/4.png"><img src="http://www.gatherlife.cn/images/docmanager/4.png"></a>
默认显示该项目下所有接口列表，用户可以通过填写搜索条件（接口名、URL、编号）点击“搜索”按钮进行筛选搜索。用户在这个页面还可以进行查看接口信息、编辑接口信息和新增接口信息。

- **接口详情信息**  

用户在“接口列表”页面，点击列表中某个接口的“查看”操作按钮，看到这个页面变化：
<a target="_blank" href="http://www.gatherlife.cn/images/docmanager/5.png"><img src="http://www.gatherlife.cn/images/docmanager/5.png"></a>
用户可在展开后的列表上查看该条接口详情信息。

- **新增接口信息**  

用户在“接口列表”页面，点击页面中“新增”按钮，看到这个页面后：
<a target="_blank" href="http://www.gatherlife.cn/images/docmanager/6.png"><img src="http://www.gatherlife.cn/images/docmanager/6.png"></a>
**填写接口基本信息，插入请求参数时，可以通过两种方式插入：**  
*方式一“批量添加”：*用户在“新增接口”页面，点击“批量添加”按钮，在弹出窗口输入xml字符串，点击弹出窗“保存”按钮，批量导入请求参数。
<a target="_blank" href="http://www.gatherlife.cn/images/docmanager/7.png"><img src="http://www.gatherlife.cn/images/docmanager/7.png"></a>
*方式二“手动添加”：*用户在“新增接口”页面，点击“添加”按钮，可在请求参数输入框中，手动输入参数信息。
<a target="_blank" href="http://www.gatherlife.cn/images/docmanager/8.png"><img src="http://www.gatherlife.cn/images/docmanager/8.png"></a>
在“新增接口”页面，点击“上传图片”按钮，上传接口示例图片，非必填。点击“提交”按钮，提交接口数据并返回“接口信息”页面。

- **编辑接口信息**  

用户在“接口列表”页面，点击列表中某个接口的“编辑”操作按钮，看到这个页面后：
<a target="_blank" href="http://www.gatherlife.cn/images/docmanager/9.png"><img src="http://www.gatherlife.cn/images/docmanager/9.png"></a>
在“编辑接口”页面，用户可以对接口进行编辑修改操作。点击“提交”按钮，提交接口数据并返回“接口信息”页面。

### 2.2 用户管理

- **用户信息管理列表***该界面只有系统管理员可进入*  

系统管理员点击左侧导航栏中的“用户管理”链接，看到这个页面后：
<a target="_blank" href="http://www.gatherlife.cn/images/docmanager/10.png"><img src="http://www.gatherlife.cn/images/docmanager/10.png"></a>
系统管理员可以在此页面查看当前系统中存在的用户，可以对这些用户进行新增和编辑操作。

- **新增用户**  

系统管理员在“用户管理”页面，点击“新增用户”按钮，看到这个页面户：
<a target="_blank" href="http://www.gatherlife.cn/images/docmanager/11.png"><img src="http://www.gatherlife.cn/images/docmanager/11.png"></a>
系统管理员在此页面手动添加可登陆本系统的用户。点击“提交”按钮，提交接口数据并返回“接口信息”页面。

- **编辑用户**  

系统管理员在“用户管理”页面，点击列表中某个用户的“编辑”操作按钮，看到这个页面后：
<a target="_blank" href="http://www.gatherlife.cn/images/docmanager/12.png"><img src="http://www.gatherlife.cn/images/docmanager/12.png"></a>
在“修改密码”页面，系统管理员可以对用户密码进行编辑修改操作。点击“提交”按钮，提交接口数据并返回“用户管理”页面。

## 3. 演示环境

**Host配置:**

	218.247.143.208		docmanager.gatherlife.cn

演示地址: <http://docmanager.gatherlife.cn/>

登录账号: admin/123456/管理员 ljx/123/普通用户

## 4. 系统架构

![部署示例图](http://www.gatherlife.cn/images/laboratory/00.png)

## 5. 安装部署

![部署示例图](http://www.gatherlife.cn/images/laboratory/01.png)

### 5.1 数据库安装

**方式一：**使用Navicat for MySQL导入sql脚本，依次执行附件中的*0.建库.sql、1.建表.sql、2.数据.sql*创建数据库环境。  
**方式二：**可参考[MySQL导入sql 文件的5大步骤](http://database.51cto.com/art/201005/200739.htm "MySQL导入sql 文件的5大步骤")导入附件中的sql脚本

### 5.2 Redis

redis是一种存储在内存中的数据库，以键值对的方式存储数据的。*(如何安装redis,再与服务器项目连接，可以另去redis官网学一下。）*本系统使用redis存储用户请求登录成功后的token信息，当前项目使用redis默认端口，127.0.0.1访问。  

**配置参考示例：**  

    JedisMode=BASIC
	Jedis.clientName=life_client
	Jedis.host=127.0.0.1
	
	Jedis.pool.maxTotal=8
	Jedis.pool.maxIdle=8
	Jedis.pool.minIdle=2
	
	Jedis.pool.testOnCreate=false
	Jedis.pool.testOnBorrow=false
	Jedis.pool.testOnReturn=false
	Jedis.pool.testWhileIdle=false
	
	Jedis.pool.maxWaitMillis=-1
	Jedis.pool.minEvictableIdleTimeMillis=1800000
	Jedis.pool.timeBetweenEvictionRunsMillis=-1
	Jedis.pool.numTestsPerEvictionRun=3

### 5.3 tomcat

**部署流程**  

1. 创建目录 /webSite  
2. 拷贝项目到 /webSite目录下直接部署，项目目录为/webSite/doc-manager  

**参考示例：**(*具体根据服务器情况配置*)

    <Host name="docmanager.gatherlife.cn"  appBase="" unpackWARs="true" autoDeploy="true">	
		<Valve className="org.apache.catalina.valves.AccessLogValve" directory="logs"  prefix="doc-manager." suffix=".log" timestamp="true"	pattern="%h %l %u %t &quot;%r&quot; %s %b" resolveHosts="false"/>
		<Context path="" docBase="/webSite/doc-manager"  caseSensitive="false" debug="0"></Context>
	</Host>

## 6. 源码地址

下载地址：<https://gitee.com/hsh2017/docmanager>

## 7. 公司介绍

北京汇生活网络科技有限公司，承接各种定制化系统开发。本公司专注于电商平台、供应链系统、P2P金融技术的研究和开发，形成了针对不同行业企业的不同规模和应用定制系列产品和针对性解决方案，是国内较有影响力的技术提供商。核心团队成员来自于百度、达飞财富等知名企业。

公司官网：<http://www.gatherlife.cn>

公司邮箱：<cs@gatherlife.cn>