基于靜態(tài)Swagger JSON文件的方式預(yù)覽很簡(jiǎn)單,首先需要一個(gè)HTTP的web服務(wù)即可
兩種選擇:
不管是基于nginx還是IIS,首先都需要先本地生成一個(gè)靜態(tài)的Swagger JSON文件結(jié)構(gòu)
swagger-bootstrap-ui
此處提供了一個(gè)簡(jiǎn)單的示例
修改項(xiàng)目json目錄下的group.json
[
{
"name": "swagger",
"url": "/json/swagger.json",
"swaggerVersion": "2.0",
"location": "/json/swagger.json"
},
{
"name": "swagger1",
"url": "/json/swagger1.json",
"swaggerVersion": "2.0",
"location": "/json/swagger1.json"
}
]
我們?cè)陟o態(tài)的group.json
文件中預(yù)定義了兩個(gè)靜態(tài)的swagger JSON文件,也同時(shí)存放在json文件夾中
swagger.json
的內(nèi)容為swagger接口/v2/api-docs
中響應(yīng)的內(nèi)容
{
"swagger": "2.0",
"info": {
"description": "<div style='font-size:14px;color:red;'>swagger-bootstrap-ui-demo RESTful APIs</div>",
"version": "1.0",
"title": "swagger-bootstrap-ui很棒~~~?。?!",
"termsOfService": "http://www.group.com/",
"contact": {
"name": "group@qq.com"
}
},
"host": "127.0.0.1:8999",
"basePath": "/"
//more.....
}
當(dāng)我們完成以上步驟后,即可通過nginx或者IIS部署靜態(tài)文件瀏覽我們的接口文檔了
基于nginx的方式,只需要將swagger-bootstrap-ui
的所有靜態(tài)文件拷貝到響應(yīng)目錄,然后再nginx的conf配置文件中配置server節(jié)點(diǎn)即可
參考信息如下:
server {
listen 18001;
server_name 192.168.0.112;
#charset koi8-r;
location / {
#此處為swagger-bootstrap-ui項(xiàng)目中resources目錄中的靜態(tài)資源;
root /mnt/application/swagger-static;
}
}
在Windows系統(tǒng)中,可以使用IIS部署我們的靜態(tài)站點(diǎn),快速預(yù)覽Swagger文檔
具體路徑:
控制面板 -> 管理工具 -> Internet Information Services (IIS)管理器 -> 添加網(wǎng)站 -> 選擇靜態(tài)目錄 -> 瀏覽
如果沒有IIS管理器,你首先需要自行安裝該服務(wù),至于如何安裝IIS,自行搜索解決,此處不再驁述.
更多建議: