您现在的位置是:主页 > Web前端技术 > Web前端技术

SpringBoot如何集成Swagger3开发技术

IDCBT2021-12-29服务器技术人已围观

简介这篇文章主要介绍SpringBoot如何集成Swagger3,文中介绍的非常详细,具有一定的参考价值,感兴趣的小伙伴们一定要看完! 一,什么是swagger? 1, Swagger 是一个规范和完整的文档框架, 用于

这篇文章主要介绍SpringBoot如何集成Swagger3,文中介绍的非常详细,具有一定的参考价值,感兴趣的小伙伴们一定要看完!

一,什么是swagger?

1,  Swagger 是一个规范和完整的文档框架,

    用于生成、描述、调用和可视化 RESTful 风格的 Web 服务文档

    官方网站:https://swagger.io/

2,使用swagger要注意的地方:

     在生产环境中必须关闭swagger,

     它本身只用于前后端工程师之间的沟通,

     可以专门使用一台内部服务器来展示ui供访问,

     即使在这上面要做好安全措施

3,  因为swagger3.0.0已发布,本文使用了最新版

     如果有还在用2.x版本的请参考时注意区分

二,SpringBoot 集成swagger3

 pom.xml 集成Swagger3依赖

<!-- swagger3 接口文档生成器 -->
		<dependency>
			<groupId>io.springfox</groupId>
			<artifactId>springfox-boot-starter</artifactId>
			<version>3.0.0</version>
			<exclusions>
				<exclusion>
					<groupId>org.springframework.plugin</groupId>
					<artifactId>spring-plugin-core</artifactId>
				</exclusion>
				<exclusion>
					<groupId>org.springframework.plugin</groupId>
					<artifactId>spring-plugin-metadata</artifactId>
				</exclusion>
			</exclusions>
		</dependency>

Swagger3 配置对象定义

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.oas.annotations.EnableOpenApi;
import springfox.documentation.service.ApiInfo;
import springfox.documentation.service.Contact;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;
 
@Configuration
@EnableOpenApi
public class Swagger3Config {
	@Bean
    public Docket createRestApi() {
        return new Docket(DocumentationType.OAS_30)
                .apiInfo(apiInfo())
                .select()
                .apis(RequestHandlerSelectors.basePackage("com.digipower.controller"))
                .paths(PathSelectors.any())
                .build();
    }
 
    private ApiInfo apiInfo() {
        return new ApiInfoBuilder().title("在奋斗的大道上 - 微信预约查档系统").termsOfServiceUrl("https://blog.csdn.net/zhouzhiwengang")
				.description("API接口")
				.contact(new Contact("https://blog.csdn.net/zhouzhiwengang","",""))
				.version("3.0").build();
    }
 
}

标签:

很赞哦! ()

本栏推荐