SpringBoot：番外篇SpringBoot+Swagger生成可視圖的API文檔

作者：Damniel

郵箱：[email protected]

微博：

博客：https://blog.csdn.net/bulletoo_（轉載請說明出處）

-----------------------------------華麗的分割線----------------------------------------

一、Swagger註解

swagger通過註解表明該接口會生成文檔，包括接口名、請求方法、參數、返回信息的等等。

• @Api：修飾整個類，描述Controller的作用
• @ApiOperation：描述一個類的一個方法，或者說一個接口
• @ApiParam：單個參數描述
• @ApiModel：用對象來接收參數
• @ApiProperty：用對象接收參數時，描述對象的一個字段
• @ApiResponse：HTTP響應其中1個描述
• @ApiResponses：HTTP響應整體描述
• @ApiIgnore：使用該註解忽略這個API
• @ApiError ：發生錯誤返回的信息
• @ApiImplicitParam：一個請求參數
• @ApiImplicitParams：多個請求參數

一、Swagger搭建

話不多說，先搭建一個jar包最少可以運行的項目

主需要做下面三個步驟：

• 在pom.xml中引入依賴：

<dependency>
		<groupId>com.gitee.reger</groupId>
		<artifactId>spring-boot-starter-swagger</artifactId>
		<version>1.0.3</version>
</dependency>

• 創建測試類，也就是要顯示在前端的內容：

@Api(value="/test", tags="測試接口模塊")
@RestController
@RequestMapping("/test")
public class TestSwaggerController {
	@ApiOperation(value="展示首頁信息", notes = "展示首頁信息")
    @GetMapping("/show")
    public Object showInfo(){
        return "hello worlddd";
    }

    @ApiOperation(value="添加用戶信息", notes = "添加用戶信息")
    @ApiImplicitParam(name="user", value="User", required = true, dataType = "User")
    @PostMapping("/addUser")
    public Object addUser(@RequestBody User user){
        return "success";
    }
}

• 在src/main/resources工程目錄下創建application.yml文件，配置如下

spring:
  profiles:
    include:
      - api

然後開始運行springboot就行了，spring-boot-starter-swagger會自動掃描配置！