swagger集成springboot

学习目标：

了解Swagger的概念及作用

掌握在项目中集成Swagger自动生成API文档

Swagger简介
前后端分离

前端 -> 前端控制层、视图层

后端 -> 后端控制层、服务层、数据访问层

前后端通过API进行交互

前后端相对独立且松耦合

产生的问题

前后端集成，前端或者后端无法做到“及时协商，尽早解决”，最终导致问题集中爆发

解决方案

首先定义schema [ 计划的提纲 ]，并实时跟踪最新的API，降低集成风险

Swagger

号称世界上最流行的API框架

Restful Api 文档在线自动生成器 => API 文档 与API 定义同步更新

直接运行，在线测试API

支持多种语言 （如：Java，PHP等）

官网：https://swagger.io/

SpringBoot集成Swagger
SpringBoot集成Swagger => springfox，两个jar包

Springfox-swagger2

swagger-springmvc

使用Swagger

要求：jdk 1.8 + 否则swagger2无法运行

步骤：

1、新建一个SpringBoot-web项目
第二步：导入依赖

<!-- https://mvnrepository.com/artifact/io.springfox/springfox-swagger2 -->
<dependency>
    <groupId>io.springfox</groupId>
    <artifactId>springfox-swagger2</artifactId>
    <version>2.9.2</version>
</dependency>
<!-- https://mvnrepository.com/artifact/io.springfox/springfox-swagger-ui -->
<dependency>
    <groupId>io.springfox</groupId>
    <artifactId>springfox-swagger-ui</artifactId>
    <version>2.9.2</version>
</dependency>

第三步：编写helloworld测是程序对不对
第四步：配置swagger

第五步：运行程序 输入 swagger-ui.html 进入页面

第六步：编写配置信息

//配置swagger信息=apiInfo；
    private ApiInfo apiInfo(){

        //作者信息
        Contact contact = new Contact("清晨", "", "2856716665@qq.com");

        return new ApiInfo(
                "清晨001-Swagger",
                "即使再小的帆也能远航",
                "1.0",
                "",
                contact,
                "Apache 2.0",
                "http://www.apache.org/licenses/LICENSE-2.0",
                new ArrayList());

第七步：配置接口扫描方式

 @Bean//配置了  swagger的Docket的实例
    public Docket docket(){
        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo())
                .select()
                //RequestHandlerSelectors  配置接口的扫描方式
                //basePackage 扫描包
                //any（）全部
                //withClassAannotation:扫描类的注解
                .apis(RequestHandlerSelectors.basePackage("com.meng.controller"))
                //过滤
                //.paths(PathSelectors.none())
                .build()
                ;

第八步：运行结果

这样就简单的配置好自己的swagger了

我的是狂神老师教的   欢迎浏览老师的博客
狂神说：swagger