关于springboot:springbootroute五整合swagger生成接口文档

目前，大多数公司都采纳了前后端拆散的开发模式，为了解决前后端人员的沟通问题，后端人员在开发接口的时候会抉择应用 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;
    }
}

三 swagger 文档简介

我就间接用图来示意了，这样看着也更加直观

swagger2 注解对应到文档上的表现形式如上。swagger2 反对在线调试，关上某个具体的接口，依据提醒填写对应的参数，点击发送就可返回响应后果。

此是 spring-boot-route 系列的第五篇文章，这个系列的文章都比较简单，次要目标就是为了帮忙首次接触 Spring Boot 的同学有一个零碎的意识。本文已收录至我的 github，欢送各位小伙伴star！

github：https://github.com/binzh303/s…

点关注、不迷路

如果感觉文章不错，欢送 关注 、 点赞 、 珍藏，你们的反对是我创作的能源，感激大家。

如果文章写的有问题，请不要悭吝，欢送留言指出，我会及时核查批改。

如果你还想更加深刻的理解我，能够微信搜寻「Java 旅途」进行关注。回复「1024」即可取得学习视频及精美电子书。每天 7:30 准时推送技术文章，让你的下班路不在孤单，而且每月还有送书流动，助你晋升硬实力！