Swagger-UI 的官方地址:
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(Jersey、Resteasy、CXF...)、Servlets和Play框架進行集成。
Swagger-js: 用於JavaScript的Swagger實現。
Swagger-node-express: Swagger模塊,用於node.js的Express web應用框架。
Swagger-ui:一個無依賴的HTML、JS和CSS集合,可以爲Swagger兼容API動態生成優雅文檔。
由於公司項目爲ci框架,直接在代碼中通過ci的一個插件,實現註釋生成文檔的功能,具體爲http://ym1623.github.io/codeigniter_apidoc/,所以此處不在用swagger-ui的文檔生成功能,主要使用其api測試功能。
首先,在github中下載swagger-ui
在服務器中打開其dist
此頁面中,通過調用json,然後實現了其具體文檔測試。
可以通過http://www.sosoapi.com/,此平臺,生成swaggerui中所需要的json格式文件