使用Swagger3自动生成RESTful API文档

夏殿灬青葛石

已于 2022-10-15 13:29:32 修改

阅读量305

点赞数

于 2022-10-15 13:19:14 首次发布

本文链接：https://blog.csdn.net/W2398439780/article/details/127333835

版权

spring boot 专栏收录该内容

11 篇文章 0 订阅

订阅专栏

导入依赖

<dependency>
        <groupId>io.springfox</groupId>
        <artifactId>springfox-boot-starter</artifactId>
        <version>3.0.0</version>
</dependency>

写配置类

package cn.itsp.demo.config;

import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.web.servlet.config.annotation.EnableWebMvc;
import springfox.documentation.builders.ApiInfoBuilder;
import springfox.documentation.builders.PathSelectors;
import springfox.documentation.builders.RequestHandlerSelectors;
	import springfox.documentation.oas.annotations.EnableOpenApi;
import springfox.documentation.service.ApiInfo;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;


@Configuration//告诉Spring容器,这是一个配置类
@EnableWebMvc//不加上报错Failed to start bean 'documentationPluginsBootstrapper'
@EnableOpenApi//启动Swagger3功能,也可以@EnableSwagger2【非阻断式升级留下的】
public class Swagger3Config {

@Bean
public Docket createRestApi() {
    return new Docket(DocumentationType.OAS_30)
            //把写好的配置信息给进去，做一个配置
            .apiInfo(apiInfo())
            .select()
            // 配置swagger显示的controller，cn包下所有api都交给swagger代理,如果不配置则默认扫描所有后端接口
            .apis(RequestHandlerSelectors.basePackage("cn"))
            .paths(PathSelectors.any()).build();
}


//API文档页面显示信息
private ApiInfo apiInfo() {
    return new ApiInfoBuilder()
            .title("演示Demo")
            .description("Swagger3演示项目")
            .version("1.0")
            .build();
}
}