swagger editor使用

swagger editor使用

swagger是一套开源的API设计工具,包括Swagger UI,Swagger Editor等。

Swagger Editor

其中Swagger Editor是个用Angular开发的WEB小程序,它可以让你用YAML来定义你的接口规范,并实时验证和现实成接口文档。

此外,它还可以通过接口文档帮你生成不同框架的服务端和客户端,方便你mock和契约测试。最后导出JSON格式的API规范,通过Swagger UI对外发布。

生成PDF接口文档

现在书写和发布API文档变得快速和轻松,但是有时候,对端希望能有一个离线的WORD或者PDF文档。但当前版本的Swagger Editor并没有导出文档的功能。

转了转github,倒是发现了几个开源项目,可以转换为PDF,但是感觉都比较繁琐。

突然想到浏览器可以打印成PDF格式,试验了一下,确实可以。不过接口很多内容都折叠起来了,看不到明细,起不到文档的作用。

不如写句JS,在控制台上运行一下,遍历下所有折叠的节点,然后单击打开。

var node = document.getElementsByClassName('toggle-handle');
for(var i= 0;i< node.length ; i++){  angular.element(node[i]).click();}

这下可以很方便的生成PDF文档了。

posted @ 2016-03-17 18:01  二胡嘈子  阅读(13181)  评论(1编辑  收藏  举报