Spring Boot集成Swagger-ui

        Swagger是接口调试工具,能友好的展示接口的调用方法,参数,分模块,十分直观的展示接口,以及进行接口调试,在前后端交互中起到很好的交接作用

文章目录

一、使用步骤

1.引入相关依赖

2.编写配置类

3.使用相关注解

4.访问Swagger页面

5.调试接口

---

一、使用步骤

1.引入相关依赖

        <dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-swagger2</artifactId>
            <version>2.9.2</version>
        </dependency>
        <dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-swagger-ui</artifactId>
            <version>2.9.2</version>
        </dependency>

2.编写配置类

package com.lyj.demo.config;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import springfox.documentation.service.ApiInfo;
import springfox.documentation.service.Contact;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;
import springfox.documentation.swagger2.annotations.EnableSwagger2;

import java.util.ArrayList;

@Configuration
@EnableSwagger2
public class SwaggerConfig {
    //配置了swagger的Docket的bean实例
    @Bean
    public Docket docket(){
        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo());
    }
    //配置Swagger信息=apiInfo
    private ApiInfo apiInfo(){
        //作者信息
        Contact contact=new Contact("李大白","","1837383***@qq.com");
        return new ApiInfo(
                "李大白的SwaggerApi文档",
                "世间永无bug",
                "v1.0",
                "",
                contact,
                "Apache 2.0",
                "http://www.apache.org/licenses/LICENSE-2.0",
                new ArrayList()
        );
    }
}

3.使用相关注解

Swagger环境搭建好,就可以使用Swagger相关注解了

package com.example.demo.controller;

import io.swagger.annotations.Api;
import io.swagger.annotations.ApiImplicitParam;
import io.swagger.annotations.ApiImplicitParams;
import io.swagger.annotations.ApiOperation;
import org.springframework.web.bind.annotation.*;

@RequestMapping("/swagger")
@RestController  //返回数据(不返回页面)注解
@Api(tags = {"swagger测试模块"}) //模块注解,在Swagger页面上这个类的接口内聚成单独模块
public class test {

    @GetMapping("/test")
    @ApiOperation("接口1") //接口名注解
    @ApiImplicitParams({
            @ApiImplicitParam(name = "id",value = "测试接收id",dataType = "Long",example = "1"),
    }) //用于Swagger页面介绍参数
    public String hello(@RequestParam(value = "id",required = true) Long id){
        return "Get请求方式  "+id;
    }

}

4.访问Swagger页面

打开浏览器,输入自己的路径加上swagger-ui.html(高版本的为swagger-ui/index.html)

我这是loclhost:8080/swagger-ui.html

5.调试接口

---

总结

        在前后端分离项目中，后端项目集成了Swagger之后，前端人员可以很好的对接口进行调用，联调，也十分直观，大大的提高了前后端交互的效率。