Springboot Swagger UI集成以及使用大全

Swagger UI基本介绍

Swagger UI为我们的Develop或者说第其他客户提供了一个UI界面，通过该UI界面，我们可以对我们的系统进行基本的API测试和调式。同时通过该UI我们也可以知道当前系统暴露出来的所有API接口. 具体界面如下

SpringBoot项目中集成Swagger UI代码

1. 引入相关包(以maven为例）

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

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

2. 集成代码到SpringBoot项目

package com.mary.demo.swagger;

import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import springfox.documentation.builders.PathSelectors;
import springfox.documentation.builders.RequestHandlerSelectors;
import springfox.documentation.service.ApiInfo;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;
import springfox.documentation.swagger2.annotations.EnableSwagger2;

/**
 * Created by marylgao on 2020/3/12.
 */
@Configuration
@EnableSwagger2
public class SwaggerConfig {

    @Bean
    public Docket api(){
        return new Docket(DocumentationType.SWAGGER_2)
                .select()
                .apis(RequestHandlerSelectors.any())
                .paths(PathSelectors.any())
                .build();
    }

}

访问Swagger-UI界面

此处域名：localhost, 端口: 8080, 如果你的域名跟端口不同，就需要修改一下域名和端口
Swagger-UI访问地址: http://localhost:8080/swagger-ui.html

使用Swagger-UI API接口进行测试

以发送请求到/hello为例，展开/hello接口。
如下图所示,我们知道该接口没有接口，所有我们直接点击右上角的Try it out,然后点击Execute即可发送消息进行测试

下图就是我们的测试结果，我们会返回Hello World.