spring-boot-route（五）整合Swagger生成介面文件

Java旅途發表於2020-10-06

目前，大多數公司都採用了前後端分離的開發模式，為了解決前後端人員的溝通問題，後端人員在開發介面的時候會選擇使用swagger2來生成對應的介面文件，swagger2提供了強大的頁面除錯功能，這樣可以有效解決前後端人員溝通難的問題。

下面我們使用SpringBoot結合swagger2生成Restful API文件。

一搭建專案，引入依賴

新建一個spring-boot-swaager的專案，引入swaager2的依賴，由於swagger2的ui不是很美觀，這裡將使用開源的swagger-bootstrap-ui做為ui。

引入依賴

<!-- swaager2依賴 -->    
<dependency>
    <groupId>io.springfox</groupId>
    <artifactId>springfox-swagger2</artifactId>
    <version>2.9.2</version>
</dependency>
<!-- swaager2ui -->
<dependency>
    <groupId>com.github.xiaoymin</groupId>
    <artifactId>swagger-bootstrap-ui</artifactId>
    <version>1.9.6</version>
</dependency>

專案中配置swagger相關資訊

@Configuration
@EnableSwagger2
public class configuration {

    @Bean
    public Docket createRestApi(){
        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo())
                .select()
                .apis(RequestHandlerSelectors.basePackage("com.javatrip.swagger.controller"))
                .paths(PathSelectors.any())
                .build();
    }

    private ApiInfo apiInfo(){
        return new ApiInfoBuilder()
                // 標題
                .title("某某專案介面文件")
                // 描述
                .description("swagger2介面文件使用演示")
                // 版本
                .version("1.0")
                // 許可證
                .license("MIT")
                // 許可證地址
                .licenseUrl("www.xx.com")
                // 服務端地址
                .termsOfServiceUrl("https://www.cnblogs.com/zhixie/")
                // 聯絡資訊
                .contact(new Contact("java旅途","https://www.cnblogs.com/zhixie/","binzh303@163.com"))
                .build();
    }
}

訪問路徑，檢視生成效果

文章中使用的這個ui，介面文件地址為ip:port/doc.html，生成的文件資訊如下：

二編寫Restful介面

新建實體類

@ApiModel("使用者實體類")
@Data
@NoArgsConstructor
@AllArgsConstructor
public class Person {
    @ApiModelProperty("姓名")
    private String name;
    @ApiModelProperty(value = "年齡")
    private int age;
}

新建Restful介面

@Api(tags = "使用者介面")
@RestController
@RequestMapping("person")
public class PersonController {

    @ApiOperation(value = "獲取使用者列表",notes = "根據name獲取使用者列表")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "name",value = "使用者姓名",dataType = "String",required = true),
            @ApiImplicitParam(name = "age",value = "年齡",dataType = "int",required = true)
    })
    @GetMapping("/{name}")
    public Person getPerson(@PathVariable("name") String name,@RequestParam int age){
        return new Person(name,age);
    }

    @ApiOperation(value = "新增使用者",notes = "根據使用者實體類新增使用者")
    @ApiImplicitParam(name = "person",value = "使用者實體類",dataType = "Person",required = true)
    @PostMapping("add")
    public int addPerson(@RequestBody Person person){
        if(StringUtils.isEmpty(person)){
            return -1;
        }
        return 1;
    }

    @ApiOperation(value = "更新使用者資訊",notes = "根據使用者實體更新使用者資訊")
    @ApiImplicitParam(name = "person",value = "使用者實體類",dataType = "Person",required = true)
    @PutMapping("update")
    public int updatePerson(@RequestBody Person person){
        if(StringUtils.isEmpty(person)){
            return -1;
        }
        return 1;
    }

    @ApiOperation(value = "刪除使用者資訊",notes = "根據使用者名稱刪除使用者資訊")
    @ApiImplicitParam(name = "name",value = "使用者姓名",dataType = "String",required = true)
    @DeleteMapping("/{name}")
    public int deletePerson(@PathVariable(name = "name") String name){
        if(StringUtils.isEmpty(name)){
            return -1;
        }
        return 1;
    }
}