文档管理方案

Restful风格文档管理工具的选择依据：

  • 团队协作修改API接口
  • 生成word、pdf、html等形式的接口文档
  • 可以内线搭建自己的API接口文档管理系统
  • 最好能够内线进行接口的测试工作

文档管理和自动化接口测试方案

  • 方案一、Swagger
  • 方案二、APIDOC + Postman（chrome插件）
  • 方案三、APIDOC + Http Client

Swagger官方站点：

APIDOC官方站点：

方案一、Swagger

以后补充

方案二、APIDOC + Postman（chrome插件）

1.下载nodejs环境

nodejs官方网站：https://nodejs.org/en/

当前使用的稳定版本下载地址：https://nodejs.org/dist/v6.9.1/node-v6.9.1-x64.msi

nodejs安装过程略

2.安装apidoc

npm install apidoc -g

3.Demo

项目所在路径 E:\workspace\testhttp

apidoc -i E:\workspace\testhttp\ -o E:\workspace\testhttp\apidoc\ -t E:\workspace\mytemplate -f ..java$ -f ..js$

apidoc -i E:\workspace\testhttp\ -o E:\workspace\testhttp\apidoc\ -t E:\workspace\mytemplate

apidoc -i E:\workspace\cmp\ -o E:\workspace\cmp\apidoc\ -t E:\workspace\mytemplate -f ..java$

4. apidoc 命令

-i （input）指定扫描项目的路径
-o （output）指定文档生成的路径
-t （template）指定文档生成的模板
-f （file-filters）扫描指定类型的文件

5.apidoc开发工具的整合和Swagger文档的转换

eclipse整合
Swagger文档的转换

6.Postman（chrome插件）

如果能够访问google 请在google应用商店中

如果不能访问google，请到Postman官方网站下载 https://www.getpostman.com/

方案三、APIDOC + Http Client

原理同方案二、APIDOC + Postman（chrome插件）

  • Postman（chrome插件）
  • Http Client 实现Postman类似的功能，可以根据自己项目的实际情况进行改造（如没有扩展需求，建议使用Postman，Postman满足当前绝大多数使用情况）

自动化部署方案设计（使用APIDOC）

  • 当代码提交到SVN或GIT服务器完成时
  • 执行文档生成命令，生成到指定的文件目录
  • 搭建在线文档Web服务器，web服务器目录同文档生成目录
***********************************************************************************************************
【版权所有，转载请注明原文链接。】 文中有不妥或者错误的地方还望指出。如果你有更好的建议，可以给我留言讨论，共同进步！ 感谢您耐心的读完本篇文章。
***********************************************************************************************************
posted @ 2017-04-06 18:41  vimx86  阅读(452)  评论(0)  编辑  收藏  举报