Docmanager 开源发布，接口文档管理系统

Linuxeden 开源社区 --

1. 项目介绍

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

2. 使用说明

2.1 项目管理

• 项目管理页面

用户登录成功后首先进入“项目管理”页面，用户可以查看项目信息、修改项目信息和新增项目信息。

• 新增项目信息

用户在“项目管理”页面，点击“新增项目”按钮，看到这个页面后：

填写项目基本信息，点击“提交”按钮保存数据，点击“返回”按钮返回“项目管理”页面。

• 编辑项目信息

用户在“项目管理”页面，点击列表中某个项目的“编辑”操作按钮，看到这个页面后：

修改项目基本信息，点击“提交”按钮修改数据，点击“返回”按钮返回“项目管理”页面。

• 接口信息列表

用户在“项目管理”页面，点击列表中某个项目的“查看”操作按钮，看到这个页面后：

默认显示该项目下所有接口列表，用户可以通过填写搜索条件（接口名、URL、编号）点击“搜索”按钮进行筛选搜索。用户在这个页面还可以进行查看接口信息、编辑接口信息和新增接口信息。

• 接口详情信息

用户在“接口列表”页面，点击列表中某个接口的“查看”操作按钮，看到这个页面变化：

用户可在展开后的列表上查看该条接口详情信息。

• 新增接口信息

用户在“接口列表”页面，点击页面中“新增”按钮，看到这个页面后：

填写接口基本信息，插入请求参数时，可以通过两种方式插入：

方式一“批量添加”： 用户在“新增接口”页面，点击“批量添加”按钮，在弹出窗口输入 xml 字符串，点击弹出窗“保存”按钮，批量导入请求参数。

方式二“手动添加”： 用户在“新增接口”页面，点击“添加”按钮，可在请求参数输入框中，手动输入参数信息。

在“新增接口”页面，点击“上传图片”按钮，上传接口示例图片，非必填。点击“提交”按钮，提交接口数据并返回“接口信息”页面。

• 编辑接口信息

用户在“接口列表”页面，点击列表中某个接口的“编辑”操作按钮，看到这个页面后：

在“编辑接口”页面，用户可以对接口进行编辑修改操作。点击“提交”按钮，提交接口数据并返回“接口信息”页面。

    2.2 用户管理

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

系统管理员点击左侧导航栏中的“用户管理”链接，看到这个页面后：

系统管理员可以在此页面查看当前系统中存在的用户，可以对这些用户进行新增和编辑操作。

• 新增用户

系统管理员在“用户管理”页面，点击“新增用户”按钮，看到这个页面户：

系统管理员在此页面手动添加可登陆本系统的用户。点击“提交”按钮，提交接口数据并返回“接口信息”页面。

• 编辑用户

系统管理员在“用户管理”页面，点击列表中某个用户的“编辑”操作按钮，看到这个页面后：

在“修改密码”页面，系统管理员可以对用户密码进行编辑修改操作。点击“提交”按钮，提交接口数据并返回“用户管理”页面。

转自 http://ift.tt/2vEk0wK

The post Docmanager 开源发布，接口文档管理系统 appeared first on Linuxeden开源社区.

http://ift.tt/2x4AKAY