编程开发 购物 网址 游戏 小说 歌词 地图 快照 股票 美女 新闻 笑话 | 汉字 软件 日历 阅读 下载 图书馆 开发 租车 短信 China
TxT小说阅读器
↓语音阅读,小说下载,古典文学↓
图片批量下载器
↓批量下载图片,美女图库↓
多播视频美女直播
↓电视,电影,美女直播,迅雷资源↓
一键清除垃圾
↓轻轻一点,清除系统垃圾↓
移动开发 架构设计 编程语言 互联网 开发经验 Web前端 开发总结
开发杂谈 系统运维 研发管理 数据库 云 计 算 Java开发
VC(MFC) Delphi VB C++(C语言) C++ Builder 其它开发语言 云计算 Java开发 .Net开发 IOS开发 Android开发 PHP语言 JavaScript
ASP语言 HTML(CSS) HTML5 Apache MSSQL数据库 Oracle数据库 PowerBuilder Informatica 其它数据库 硬件及嵌入式开发 Linux开发资料
  编程开发知识库 -> 研发管理 -> 接口文档管理方案 -> 正文阅读
 

[研发管理]接口文档管理方案[第1页]

Restful风格文档管理工具的选择依据: 团队协作修改API接口 生成word、pdf、html等形式的接口文档 可以内线搭建自己的API接口文档管理系统 最好能够内线进行接口的测试工作 文档管理和自动化接口测试方案 方案一、Swagger 方案二、APIDOC + Postman(chrome插件) 方案三、APIDOC + Http Client Swagger官方站点: http://swagger.io/ APIDOC官方站点: https://github.com/apidoc/apidoc http://apidocjs.com/ 方案一、Swagger
Swagger 方案集成在项目中,随行项目进行发布,附带接口测试环境
1.引入 Swagger 的 Maven 依赖

        <!-- swagger2 start -->
        <dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-swagger2</artifactId>
            <version>${swagger2.version}</version>
        </dependency>
        <dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-swagger-ui</artifactId>
            <version>${swagger2.version}</version>
        </dependency>
        <!-- swagger2 end -->

2.在Spring 项目中配置 Swagger


/**
 * Description: Swagger2构建强大的RESTful API文档
 * <br />Author: vimx86
 */
@Configuration
@EnableSwagger2
public class Swagger2Config {

    @Bean
    public Docket createRestApi() {
        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo())
                .select()
                .apis(RequestHandlerSelectors.basePackage("org.galsang.admin.controller"))
                .paths(PathSelectors.any())
                .build();
    }

    private ApiInfo apiInfo() {
        return new ApiInfoBuilder()
                .title("RESTful APIs For lxy-admin ")
                .description("lxy-admin")
                .termsOfServiceUrl("https://gitee.com/vimx86")
                .contact("vimx86")
                .version("1.0")
                .build();
    }

}

3. 使用Swagger 进行协作
启动项目,使用浏览器打开 : 项目地址 + swagger-ui.html
例如笔者的项目地址为: http://127.0.0.1:8088
那么接口文档的地址就为: http://127.0.0.1:8088/swagger-ui.html

方案二、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整合 https://github.com/skhani/eclipse_java_apiDoc_templates https://github.com/DWand/eclipse_pdt_apiDoc_editor_templates Swagger文档的转换 https://github.com/fsbahman/apidoc-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服务器目录同文档生成目录 自动化部署方案设计(使用Swagger ) 使用Swagger 方案集成在项目中,随行项目进行发布,不需要单独部署
以上两种方式各有利弊,请结合自身业务进行方案的合理规划。
PS: 以上两种都没有符合选择依据,具体实施方案可以根据人力物力需求进行规划实施。 *************************************************************************************************
文中有不妥或者错误的地方还望指出。
如果你有更好的建议,可以给我留言讨论,共同进步! 感谢您耐心的读完本篇文章。
【版权所有,转载请注明原文链接。】
*************************************************************************************************
阅读全文
版权声明:原创文章,版权所有,转载请注明原文链接
本文已收录于以下专栏:

发表评论
HTML/XML objective-c Delphi Ruby PHP C# C++ JavaScript Visual Basic Python Java CSS SQL 其它
相关文章推荐
在线接口文档管理工具(小幺鸡)使用说明
在线接口文档管理工具(小幺鸡)使用说明前言小幺鸡的地址:http://www.xiaoyaoji.cn/几大看点:在线接口测试; 可视化编辑与分享; 代码开源。可以离线部署。
qincidong 2017-07-26 10:39 1086

CrapApi api接口文档管理系统
2017-04-21 15:57 52.03MB 下载

毕业设计文档管理系统方案
2011-12-16 09:25 464KB 下载
破解“致得E6协同文档管理系统” 3.2.847版
此文原来被删除过,但现在致得E6也已经升级到5.5了,应该没什么影响,再次贴出来作为技术讨论。 声明:本文纯粹出于学习目的,如果用于商业目的造成法律责任后果自负。 最近研究软件加密问题,看...
Nocky 2012-10-04 21:39 7053

APISystem接口文档管理系统 免费版
2017-04-01 11:06 4.65MB 下载
Introducing Document Management in SharePoint 2010 介绍SharePoint 2010中的文档管理
Introducing Document Management in SharePoint 2010 Hi everyone. It's Adam here again – this time I w...
u012025054 2013-11-23 16:06 870 SharePoint 2010 文档管理系列之准备篇
前言:很早自己就想写一个系列的文章,但是不知道写什么,最近在QQ群里,好多人说在做文档管理,其实文档管理也是SharePoint的一个很不错的功能点,自己想了想,也想多学习点东西,所以写这个主题吧,今...
linyustar 2013-07-30 10:58 1336 QMIS项目文档管理系统发布
QMIS项目文档管理系统是一个准开源的系统(之所以称之为准开源,是因为在系统中使用到了一个收费的Office中间件SOAOffice,用于实现文档的在线编辑,在此也希望大家能提供一款开源的Office...
leishangwen 2012-04-15 17:17 2706 MongoDB学习笔记(2):数据库/集合/文档管理
数据库管理 集合管理 文档管理
wangnan537 2016-12-28 11:08 350 文档管理,PDF控件PDF-XChange PRO SDK
PDF-XChange PRO SDK以免收版权费用的方式向软件开发者提供,这意味着使用他们的软件可以创建与Adobe PDF兼容的文件,实现报表的生成,或者以其他输出方式来替代纸张打印。并且它几乎可...
u014542704 2014-04-14 16:55 1087
vimx86 +关注
原创 7 粉丝 0 喜欢 0 码云  
他的最新文章 更多文章
Plant UML 设计 vue 入门之安装Webpack Docker与虚拟机性能比较 虚拟机与Docker有何不同?
在线课程

【免费】搜狗机器翻译技术分享
讲师:

深度学习在推荐领域的应用和实践
讲师:吴岸城
热门文章 常用Linux命令记录
85
Docker's 学习资料
28
vue 入门之安装Webpack
27
某小公司RESTful、共用接口、前后端分离、接口约定的实践
21
Plant UML 设计
18
0
  研发管理 最新文章
开始使用代码编辑器——Sublime Text 3
程序调试
别告诉我你会记笔记——工作中如何使用笔记
android wss 连接不上ejabberd服务器的处理
软件配置管理基线解释
软件配置管理中三个基线概念
伙伴系统之伙伴系统概述
C#之字符匹配
查看域名是否支持IPv6
你对Linux窗口管理程序Tmux了解吗
上一篇文章      下一篇文章      查看所有文章
加:2017-10-29 22:03:55  更:2017-10-29 22:05:51 
VC(MFC) Delphi VB C++(C语言) C++ Builder 其它开发语言 云计算 Java开发 .Net开发 IOS开发 Android开发 PHP语言 JavaScript
ASP语言 HTML(CSS) HTML5 Apache MSSQL数据库 Oracle数据库 PowerBuilder Informatica 其它数据库 硬件及嵌入式开发 Linux开发资料
360图书馆 软件开发资料 文字转语音 购物精选 软件下载 美食菜谱 新闻资讯 电影视频 小游戏 Chinese Culture 股票 租车
生肖星座 三丰软件 视频 开发 短信 中国文化 网文精选 搜图网 美图 阅读网 多播 租车 短信 看图 日历 万年历 2018年4日历
2018-4-23 1:57:59
多播视频美女直播
↓电视,电影,美女直播,迅雷资源↓
TxT小说阅读器
↓语音阅读,小说下载,古典文学↓
一键清除垃圾
↓轻轻一点,清除系统垃圾↓
图片批量下载器
↓批量下载图片,美女图库↓
  网站联系: qq:121756557 email:121756557@qq.com  编程开发知识库