Swagger-UI的配置與使用

Swagger-UI 的官方地址：

http://swagger.wordnik.com

Github上的項目地址：

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

官方提供的demo地址

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

Swagger 是一個規(guī)范和完整的框架，用于生成、描述、調(diào)用和可視化 RESTful 風格的 Web 服務(wù)。Swagger的目標是對REST API定義一個標準的和語言無關(guān)的接口，可讓人和計算機無需訪問源碼、文檔或網(wǎng)絡(luò)流量監(jiān)測就可以發(fā)現(xiàn)和理解服務(wù)的能力。當通過Swagger進行正確定義，用戶可以理解遠程服務(wù)并使用最少實現(xiàn)邏輯與遠程服務(wù)進行交互。與為底層編程所實現(xiàn)的接口類似，Swagger消除了調(diào)用服務(wù)時可能會有的猜測。

Swagger是一組開源項目，其中主要要項目如下：

Swagger-tools:提供各種與Swagger進行集成和交互的工具。例如模式檢驗、Swagger 1.2文檔轉(zhuǎn)換成Swagger 2.0文檔等功能。

Swagger-core: 用于Java/Scala的的Swagger實現(xiàn)。與JAX-RS(Jersey、Resteasy、CXF...)、Servlets和Play框架進行集成。

Swagger-js: 用于JavaScript的Swagger實現(xiàn)。

Swagger-node-express: Swagger模塊，用于node.js的Express web應(yīng)用框架。

Swagger-ui：一個無依賴的HTML、JS和CSS集合，可以為Swagger兼容API動態(tài)生成優(yōu)雅文檔。

由于公司項目為ci框架，直接在代碼中通過ci的一個插件，實現(xiàn)注釋生成文檔的功能，具體為http://ym1623.github.io/codeigniter_apidoc/，所以此處不在用swagger-ui的文檔生成功能，主要使用其api測試功能。

首先，在github中下載swagger-ui

在服務(wù)器中打開其dist

此頁面中，通過調(diào)用json，然后實現(xiàn)了其具體文檔測試。

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