下载API json文档

步骤说明
  1. 下载在线编辑后的API json文档,假设文档名称为"demo.json"
注意事项
  1. 文件名不能包含空格,"-"等特殊字符

下载Swagger UI扩展版

部署SwaggerUI

步骤说明
  1. 以web服务器tomcat7为例,其他服务器按部署静态站点方式部署即可。
  2. 将SwaggerUI扩展版解压到{TOMCAT_HOME}/webapps目录下, 下载的API json文档放到{TOMCAT_HOME}/webapps/SwaggerUI/json/目录下。
  3. 启动tomcat

 

访问SwaggerUI

步骤说明
  1. 假设tomcat端口为8080
  2. 直接在浏览器中输入"http://localhost:8080/SwaggerUI",即可出现如下界面

访问API文档并测试

步骤说明
  1. 在SwaggerUI界面输入框中将“http://petstore.swagger.io/v2/swagger.json” 替换为"http://localhost:8080/SwaggerUI/json/demo.json"
  2. 点击"explore"即可以看到对应的API文档
注意事项
  1. 如果出现网站预览和本地预览效果不一致,可能是SwaggerUI版本已升级,需重新下载。
  2. 若测试时,"Response Headers"返回如下信息,则应该是ajax跨域请求问题。可参考"常见问题->线下部署"中的跨域请求相关资料后处理。

    	{
    	  "error": "no response from server"
    	}