Swagger-UI 的官方地址:

http://swagger.wordnik.com

Github上的项目地址:

https://github.com/wordnik/swagger-ui

官方提供的demo地址

http://petstore.swagger.wordnik.com/

 

Swagger 是一个规范和完整的框架,用于生成、描述、调用和可视化 RESTful 风格的 Web 服务。Swagger的目标是对REST API定义一个标准的和语言无关的接口,可让人和计算机无需访问源码、文档或网络流量监测就可以发现和理解服务的能力。当通过Swagger进行正确定义,用户可以理解远程服务并使用最少实现逻辑与远程服务进行交互。与为底层编程所实现的接口类似,Swagger消除了调用服务时可能会有的猜测。

Swagger是一组开源项目,其中主要要项目如下:

Swagger-tools:提供各种与Swagger进行集成和交互的工具。例如模式检验、Swagger 1.2文档转换成Swagger 2.0文档等功能。

Swagger-core: 用于Java/Scala的的Swagger实现。与JAX-RS(JerseyResteasyCXF...)ServletsPlay框架进行集成。

Swagger-js: 用于JavaScriptSwagger实现。

Swagger-node-express: Swagger模块,用于node.jsExpress web应用框架。

Swagger-ui:一个无依赖的HTMLJSCSS集合,可以为Swagger兼容API动态生成优雅文档。

 

由于公司项目为ci框架,直接在代码中通过ci的一个插件,实现注释生成文档的功能,具体为http://ym1623.github.io/codeigniter_apidoc/,所以此处不在用swagger-ui的文档生成功能,主要使用其api测试功能。

首先,在github中下载swagger-ui

在服务器中打开其dist

此页面中,通过调用json,然后实现了其具体文档测试。

可以通过http://www.sosoapi.com/,此平台,生成swaggerui中所需要的json格式文件