Swagger簡介:
- Swagger 是一款RESTFUL接口的文檔在線自動生成+功能測試功能軟件。
- Swagger 是一個規範和完整的框架,用於生成、描述、調用和可視化 RESTful 風格的 Web 服務。
首先添加swagger依賴(maven管理):
- <!-- swagger -->
- <dependency>
- <groupId>com.mangofactory</groupId>
- <artifactId>swagger-springmvc</artifactId>
- <version>1.0.2</version>
- </dependency>
- <dependency>
- <groupId>com.fasterxml.jackson.core</groupId>
- <artifactId>jackson-core</artifactId>
- <version>2.5.1</version>
- </dependency>
- <dependency>
- <groupId>com.fasterxml.jackson.core</groupId>
- <artifactId>jackson-databind</artifactId>
- <version>2.5.1</version>
- </dependency>
- <dependency>
- <groupId>com.fasterxml.jackson.core</groupId>
- <artifactId>jackson-annotations</artifactId>
- <version>2.5.1</version>
- </dependency>
創建自定義swagger初始化配置文件:
- package com.ksf.server.util;
-
import com.mangofactory.swagger.configuration.SpringSwaggerConfig;
-
import com.mangofactory.swagger.models.dto.ApiInfo;
- import com.mangofactory.swagger.plugin.EnableSwagger;
-
import com.mangofactory.swagger.plugin.SwaggerSpringMvcPlugin;
-
import org.springframework.beans.factory.annotation.Autowired;
-
import
org.springframework.context.annotation.Bean;
-
import
org.springframework.context.annotation.ComponentScan;
-
import
org.springframework.context.annotation.Configuration;
-
import
org.springframework.web.servlet.config.annotation.EnableWebMvc;
-
/**
- * 描述:
-
*
@author Idowww.
-
*
@date 2017/01/27.
-
*/
- @Configuration
- @EnableSwagger
-
@EnableWebMvc
- @ComponentScan({"com.mangofactory.swagger"})
- public class SwaggerConfig {
- private SpringSwaggerConfig springSwaggerConfig;
- /**
- * Required to autowire SpringSwaggerConfig
- */
- @Autowired
- public void setSpringSwaggerConfig(SpringSwaggerConfig springSwaggerConfig)
- {
- this.springSwaggerConfig = springSwaggerConfig;
- }
- /**
- * Every SwaggerSpringMvcPlugin bean is picked up by the swagger-mvc
- * framework - allowing for multiple swagger groups i.e. same code base
- * multiple swagger resource listings.
- */
- @Bean
- public SwaggerSpringMvcPlugin customImplementation()
- {
- return new SwaggerSpringMvcPlugin(this.springSwaggerConfig)
- .apiInfo(apiInfo())
- .includePatterns(".*");
- }
- private ApiInfo apiInfo()
- {
- ApiInfo apiInfo = new ApiInfo(
- "KSF ACT",
- "康師傅二維碼促銷模塊, 項目基礎目錄是 /server/ , /b/ 目錄是店鋪端的接口, /c/ 目錄是客戶端的接口",
- "開發者:Idowww",
- "[email protected]",
- "MIT License",
- "/LICENSE");
- return apiInfo;
- }
- }
- <!-- 啓用MVC註解 -->
- <mvc:annotation-driven />
- <!-- 將 springSwaggerConfig加載到spring容器 -->
- <bean class="com.mangofactory.swagger.configuration.SpringSwaggerConfig" />
- <!-- 將自定義的swagger配置類加載到spring容器 -->
- <bean class="com.ksf.server.util.SwaggerConfig" />
- package com.ksf.server.controller.b;
- import org.springframework.beans.factory.annotation.Autowired;
- import org.springframework.stereotype.Controller;
- import org.springframework.web.bind.annotation.RequestBody;
- import org.springframework.web.bind.annotation.RequestMapping;
- import org.springframework.web.bind.annotation.ResponseBody;
- import com.ksf.server.bean.session.ShopUserBean;
- import com.ksf.server.consts.ResCode;
- import com.ksf.server.dto.BaseReq;
- import com.ksf.server.dto.BaseRes;
- import com.ksf.server.dto.b.RedPackageListRespBean;
- import com.ksf.server.dto.b.RedPackageReqBean;
- import com.ksf.server.service.RedPackageService;
- import com.mangofactory.swagger.annotations.ApiIgnore;
- import com.wordnik.swagger.annotations.ApiOperation;
- @Api(value="redPackage")
- @Controller
- @RequestMapping(value="/b/redPackage")
- public class UserController {
- @Autowired
- private RedPackageService redPackageService;
- @RequestMapping(value = "/queryRedpackageList")
- @ResponseBody
- @ApiOperation(value = "公衆號獲取紅包列表的接口", notes = "公衆號獲取紅包列表的列表", httpMethod = "POST")
- public BaseRes<RedPackageListRespBean> list(@RequestBody BaseReq<RedPackageReqBean> req, @ApiIgnore BaseRes<RedPackageListRespBean> res,@ApiIgnore ShopUserBean shopUserBean) {
- RedPackageReqBean reqBean = req.getRequest();
- if (reqBean == null) {
- return res.setRes(ResCode.ARGS_ERROR.getCode(), "請求參數不能爲空");
- }
- Long shopId = shopUserBean.getShopAssistant().getId();
- RedPackageListRespBean respBean = redPackageService.listRedPackageRecord(reqBean,shopId);
- res.setResponse(respBean);
- res.setCode(ResCode.OK.getCode());
-
res.setDes(ResCode.OK.getDes());
- return res;
-
}
- }
在GitHub上將SwaggerUi下載,地址:https://github.com/swagger-api/swagger-ui
解壓後將dist文件夾中所有的文件拷貝到webapp/swagger這裏的swagger是自定義的,可以寫成自己創建的目錄。
修改index.html中的 http://petstore.swagger.wordnik.com/v2/swagger.json修改爲自己項目路徑+api-docs,例如:http://localhost:8080/server/api-docs:server爲項目名稱。
在spring-mvc.xml中過濾掉swagger-ui的文件:
- <!-- 靜態資源文件,不會被Spring MVC攔截 -->
- <mvc:resources mapping="/swagger/**" location="/swagger/" />
在瀏覽器中訪問:http://localhost:8080/server/swagger/index.html#/b/redPackage/queryRedpackageList