1.4 接口文档系统

        功能测试的一句有产品需求文档、开发设计文档等，而接口测试的主要依据是接口测试文档。由于前后端分离，用传统的Word文件来维护接口文档的方式已经不合时宜，现在，越来越多的团队采用API文档来维护接口信息。本节将详细介绍一个维护接口文档的在线系统。

1.4.1 ShowDoc简介

        目前，有很多维护API文档的工具，我们选择ShowDoc，主要因为ShowDoc有以下特点。

        a. ShowDoc是一个开源、免费的工具。

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

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

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

1.4.2 接口测试文档示例

        目前，有的公司可能没有接口文档，或者测试人员没有查看接口文档的权限，读者可以通过本书的项目接口文档进行了解。

        一个完整的API文档应该包含以下几部分。

        a. 接口名称。

        b. 简要描述。

        c. 请求的URL。

        d. 请求方式（GET/POST等）。

        e. 请求参数（参数名、是否必选、参数类型、说明）。

        f. 返回示例。

        g. 返回参数说明（参数名、类型、说明）。

        h. 备注及负责人。