springboot + swagger 實例代碼

更新時間：2017年05月08日 11:28:45 作者：趙計剛

本篇文章主要介紹了springboot + swagger 實例代碼，小編覺得挺不錯的，現(xiàn)在分享給大家，也給大家做個參考。一起跟隨小編過來看看吧

swagger用于定義API文檔。

好處：

前后端分離開發(fā)
API文檔非常明確
測試的時候不需要再使用URL輸入瀏覽器的方式來訪問Controller
傳統(tǒng)的輸入URL的測試方式對于post請求的傳參比較麻煩（當然，可以使用postman這樣的瀏覽器插件）
spring-boot與swagger的集成簡單的一逼

1、項目結構

和上一節(jié)一樣，沒有改變。

2、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>

3、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）

4、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="請求參數(shù)沒填好"),
    @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：用在方法上包含一組參數(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ù)是否必須傳