接口文档系统:SHOWDOC

功能测试的依据有产品需求文档、开发设计文档等,而接口测试的主要依据时接口测试文档。由于前后端分离,用传统的WORD文件来维护接口文档的方式已经不合时宜,现在,越来越多的团队采用API文档工具来维护接口信息。

1.ShowDoc简介

目前有很多维护API文档的工具,ShowDoc有如下特点:

ShowDoc是一个开源、免费的软件

ShowDoc是一个非常适合IT团队的在线API文档、技术文档工具,他可以实现同步,用户无需花费过多的精力维护文档

借助ShowDoc可以方便、快速的编写出美观的API文档,并且还可以用它编辑数据字典、说明书和一些技术规范说明文档供团队查阅

ShowDoc提供免费在线文档托管服务,用户可以通过ShowDoc官网创建自己的项目,并将其保存在云端,也可以选择将ShowDoc部署到本地服务器

2.ShowDoc部署

既然ShowDoc已经提供了在线文档托管服务,为什么还要搭建本地服务呢?这主要从安全角度进行考虑,毕竟接口文档不适合暴露在纵目睽睽之下,下面主要讲解如何在本地服务器上部署ShowDoc

获取源码

git clone https://github.com/star7th/showdoc.git

安装sqlite

Apt-get install sqlite sqlite3

安装phpsqlite

apt-get install php7-sqlite3