spring-boot-route（五）整合Swagger生成接口文檔

本文轉載自查看原文 2020-10-06 00:13 611 spring-boot-route

目前，大多數公司都采用了前后端分離的開發模式，為了解決前后端人員的溝通問題，后端人員在開發接口的時候會選擇使用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;
    }
}