swagger用于定義API文檔。
好處：
- 前后端分離開發(fā)
- API文檔非常明確
- 測試的時候不需要再使用URL輸入瀏覽器的方式來訪問Controller
- 傳統(tǒng)的輸入URL的測試方式對于post請求的傳參比較麻煩（當然，可以使用postman這樣的瀏覽器插件）
- spring-boot與swagger的集成簡單的一逼
1、項目結構
和上一節(jié)一樣，沒有改變。
2、pom.xml
引入了兩個jar。
|
1
2
3
4
5
6
7
8
9
10
|
<dependency> <groupId>io.springfox</groupId> <artifactId>springfox-swagger2</artifactId> <version>2.2.2</version> </dependency> <dependency> <groupId>io.springfox</groupId> <artifactId>springfox-swagger-ui</artifactId> <version>2.2.2</version> </dependency> |
3、Application.java
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
|
package com.xxx.firstboot;import org.springframework.boot.SpringApplication;import org.springframework.boot.autoconfigure.SpringBootApplication;import springfox.documentation.swagger2.annotations.EnableSwagger2;@SpringBootApplication //same as @Configuration+@EnableAutoConfiguration+@ComponentScan@EnableSwagger2 //啟動swagger注解public class Application { public static void main(String[] args) { SpringApplication.run(Application.class, args); }} |
說明：
引入了一個注解@EnableSwagger2來啟動swagger注解。（啟動該注解使得用在controller中的swagger注解生效，覆蓋的范圍由@ComponentScan的配置來指定，這里默認指定為根路徑"com.xxx.firstboot"下的所有controller）
4、UserController.java
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
|
package com.xxx.firstboot.web;import org.springframework.beans.factory.annotation.Autowired;import org.springframework.web.bind.annotation.RequestHeader;import org.springframework.web.bind.annotation.RequestMapping;import org.springframework.web.bind.annotation.RequestMethod;import org.springframework.web.bind.annotation.RequestParam;import org.springframework.web.bind.annotation.RestController;import com.xxx.firstboot.domain.User;import com.xxx.firstboot.service.UserService;import io.swagger.annotations.Api;import io.swagger.annotations.ApiImplicitParam;import io.swagger.annotations.ApiImplicitParams;import io.swagger.annotations.ApiOperation;import io.swagger.annotations.ApiResponse;import io.swagger.annotations.ApiResponses;@RestController@RequestMapping("/user")@Api("userController相關api")public class UserController { @Autowired private UserService userService; // @Autowired// private MyRedisTemplate myRedisTemplate; @ApiOperation("獲取用戶信息") @ApiImplicitParams({ @ApiImplicitParam(paramType="header",name="username",dataType="String",required=true,value="用戶的姓名",defaultValue="zhaojigang"), @ApiImplicitParam(paramType="query",name="password",dataType="String",required=true,value="用戶的密碼",defaultValue="wangna") }) @ApiResponses({ @ApiResponse(code=400,message="請求參數(shù)沒填好"), @ApiResponse(code=404,message="請求路徑?jīng)]有或頁面跳轉路徑不對") }) @RequestMapping(value="/getUser",method=RequestMethod.GET) public User getUser(@RequestHeader("username") String username, @RequestParam("password") String password) { return userService.getUser(username,password); } // @RequestMapping("/testJedisCluster")// public User testJedisCluster(@RequestParam("username") String username){// String value = myRedisTemplate.get(MyConstants.USER_FORWARD_CACHE_PREFIX, username);// if(StringUtils.isBlank(value)){// myRedisTemplate.set(MyConstants.USER_FORWARD_CACHE_PREFIX, username, JSON.toJSONString(getUser()));// return null;// }// return JSON.parseObject(value, User.class);// } } |
說明：
1、@Api：用在類上，說明該類的作用
2、@ApiOperation：用在方法上，說明方法的作用
3、@ApiImplicitParams：用在方法上包含一組參數(shù)說明
4、@ApiImplicitParam：用在@ApiImplicitParams注解中，指定一個請求參數(shù)的各個方面
1、paramType：參數(shù)放在哪個地方 header-->請求參數(shù)的獲取：@RequestHeader
①query-->請求參數(shù)的獲取：@RequestParam
② path（用于restful接口）-->請求參數(shù)的獲取：@PathVariable
③body（不常用）
④ form（不常用）
2、name：參數(shù)名
3、dataType：參數(shù)類型
4、required：參數(shù)是否必須傳
5、value：參數(shù)的意思
6、defaultValue：參數(shù)的默認值
5、@ApiResponses：用于表示一組響應
6、@ApiResponse：用在@ApiResponses中，一般用于表達一個錯誤的響應信息
1、code：數(shù)字，例如400
2、message：信息，例如"請求參數(shù)沒填好"
3、response：拋出異常的類
7、@ApiModel：描述一個Model的信息（這種一般用在post創(chuàng)建的時候，使用@RequestBody這樣的場景，請求參數(shù)無法使
1、@ApiImplicitParam注解進行描述的時候） @ApiModelProperty：描述一個model的屬性
以上這些就是最常用的幾個注解了。
需要注意的是：
ApiImplicitParam這個注解不只是注解，還會影響運行期的程序，例子如下：
如果ApiImplicitParam中的phone的paramType是query的話，是無法注入到rest路徑中的，而且如果是path的話，是不需要配置ApiImplicitParam的，即使配置了，其中的value="手機號"也不會在swagger-ui展示出來。
具體其他的注解，查看：https://github.com/swagger-api/swagger-core/wiki/Annotations#apimodel
測試：
啟動服務，瀏覽器輸入"http://localhost:8080/swagger-ui.html"
最上邊一個紅框：@Api
GET紅框：method=RequestMethod.GET
右邊紅框：@ApiOperation
parameter紅框：@ApiImplicitParams系列注解
response messages紅框：@ApiResponses系列注解
輸入?yún)?shù)后，點擊"try it out!"，查看響應內容：
以上就是本文的全部內容，希望對大家的學習有所幫助，也希望大家多多支持服務器之家。
原文鏈接：http://www.cnblogs.com/java-zhao/p/5348113.html
