java练习生 - swagger

一、添加依赖

<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>

二、创建配置类

import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import springfox.documentation.builders.ApiInfoBuilder;
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;

@Configuration
@EnableSwagger2
public class SwaggerConfig {

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

    private ApiInfo apiInfo(){
        return new ApiInfoBuilder()
                .title("TEST API Doc")
                .description("This is a restful api document of TEST.")
                .version("1.0")
                .build();
    }
}

三、使用

【接口地址+/swagger-ui.html】即可打开swagger接口界面。

 

这里只提供swagger最基础应用。更多功能，可以参考网上其他资料。

https://www.cnblogs.com/zs-notes/p/10845741.html

https://blog.csdn.net/qq_41373681/article/details/108123986

注意：因接口服务需要接入网关，要求swagger-ui.html的访问路径与业务接口一致，可以通过在YML配置中添加统一的访问地址。

server:
  servlet:
    context-path: /api/configure-web