springboot06-swagger2 自動化api文檔

1.springboot 項目中添加swagger2依賴：

        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>

        <dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-swagger2</artifactId>
            <version>2.2.2</version>
        </dependency>

2.啟動類中添加swagger注解支持：

@SpringBootApplication
@EnableSwagger2 //啟動swagger注解 啟動服務，瀏覽器輸入"http://服務名:8080/swagger-ui.html"
@ComponentScan(basePackages = {"com.mlxs.springboot06.swagger"})
public class MainApp {
    public static void main(String[] args) {
        SpringApplication.run(MainApp.class, args);
    }
}

3.自定義接口中填寫api文檔信息：

package com.mlxs.springboot06.swagger;


import com.mlxs.springboot06.swagger.bean.User;
import io.swagger.annotations.ApiImplicitParam;
import io.swagger.annotations.ApiOperation;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestMethod;
import org.springframework.web.bind.annotation.RestController;

import java.util.ArrayList;
import java.util.List;

/**
 * UserResource類描述:
 *
 * swagger2使用說明：
         @Api：用在類上，說明該類的作用
         @ApiOperation：用在方法上，說明方法的作用
         @ApiImplicitParams：用在方法上包含一組參數說明
         @ApiImplicitParam：用在@ApiImplicitParams注解中，指定一個請求參數的各個方面
            paramType：參數放在哪個地方
                 header-->請求參數的獲取：@RequestHeader
                 query-->請求參數的獲取：@RequestParam
                 path（用於restful接口）-->請求參數的獲取：@PathVariable
                 body（不常用）
                 form（不常用）
             name：參數名
             dataType：參數類型
             required：參數是否必須傳
             value：參數的意思
             defaultValue：參數的默認值
         @ApiResponses：用於表示一組響應
         @ApiResponse：用在@ApiResponses中，一般用於表達一個錯誤的響應信息
             code：數字，例如400
             message：信息，例如"請求參數沒填好"
             response：拋出異常的類
         @ApiModel：描述一個Model的信息（這種一般用在post創建的時候，使用@RequestBody這樣的場景，請求參數無法使用@ApiImplicitParam注解進行描述的時候）
            @ApiModelProperty：描述一個model的屬性
 *
 * @author yangzhenlong
 * @since 2017/2/20
 */
@RestController
@RequestMapping("/user")
public class UserResource {

    @ApiOperation(value = "用戶列表", httpMethod = "GET")
    @RequestMapping(value = "/list", method = {RequestMethod.GET})
    public List<User> userList(){
        List<User> userList = new ArrayList<>();
        for (int i=1; i<= 5; i++){
            User user = new User(i, "用戶" + i);
            userList.add(user);
        }
        return userList;
    }

    @ApiOperation(value = "根據Id獲取用戶信息", httpMethod = "GET")
    @ApiImplicitParam(paramType = "query", name = "id", required = true, value = "用戶id", defaultValue = "1")
    @RequestMapping(value = "/get", method = {RequestMethod.GET})
    public User userList(Integer id){
        List<User> userList = new ArrayList<>();
        for (int i=1; i<= 5; i++){
            User user = new User(i, "用戶" + i);
            userList.add(user);
        }
        return userList.get(id -1);
    }
}

4.啟動MainApp類，瀏覽器訪問http://localhost:8080/swagger-ui.html 查看效果：