這篇文章將為大家詳細講解有關如何在springboot項目中使用 swagger，文章內容質量較高，因此小編分享給大家做個參考，希望大家閱讀完這篇文章后對相關知識有一定的了解。
1、pom.xml
引入了兩個jar。
<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>2、Application.java
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）
3、UserController.java
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="請求參數沒填好"),
@ApiResponse(code=404,message="請求路徑沒有或頁面跳轉路徑不對")
})
@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：用在方法上包含一組參數說明
4、@ApiImplicitParam：用在@ApiImplicitParams注解中，指定一個請求參數的各個方面
1、paramType：參數放在哪個地方 header-->請求參數的獲?。篅RequestHeader
①query-->請求參數的獲?。篅RequestParam
② path（用于restful接口）-->請求參數的獲?。篅PathVariable
③body（不常用）
④ form（不常用）
2、name：參數名
3、dataType：參數類型
4、required：參數是否必須傳
5、value：參數的意思
6、defaultValue：參數的默認值
5、@ApiResponses：用于表示一組響應
6、@ApiResponse：用在@ApiResponses中，一般用于表達一個錯誤的響應信息
1、code：數字，例如400
2、message：信息，例如"請求參數沒填好"
3、response：拋出異常的類
7、@ApiModel：描述一個Model的信息（這種一般用在post創建的時候，使用@RequestBody這樣的場景，請求參數無法使
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系列注解
輸入參數后，點擊"try it out!"，查看響應內容：
關于如何在springboot項目中使用 swagger就分享到這里了，希望以上內容可以對大家有一定的幫助，可以學到更多知識。如果覺得文章不錯，可以把它分享出去讓更多的人看到。
免責聲明：本站發布的內容（圖片、視頻和文字）以原創、轉載和分享為主，文章觀點不代表本網站立場，如果涉及侵權請聯系站長郵箱：is@yisu.com進行舉報，并提供相關證據，一經查實，將立刻刪除涉嫌侵權內容。
