Swagger 修改默认配置

最新推荐文章于 2025-02-15 19:03:06 发布

呐呐呐-

最新推荐文章于 2025-02-15 19:03:06 发布

阅读量6.5k

点赞数

分类专栏： Java springboot swagger 文章标签： spring java spring boot

本文链接：https://blog.csdn.net/Sky_for_me/article/details/107579627

版权

本文介绍了如何修改Swagger的默认配置，通过创建Docket并指定DocumentationType，自定义ApiInfo对象来个性化设置Swagger的作者、版本等信息。完成配置后，运行项目并在http://localhost:8080/swagger-ui.html查看效果。

摘要生成于 C知道，由 DeepSeek-R1 满血版支持，前往体验 >

swagger配置

package com.sky.config;

import org.springframework.context.annotation.Configuration;
import springfox.documentation.oas.annotations.EnableOpenApi;
import springfox.documentation.swagger2.annotations.EnableSwagger2;

/**
 * 使用swagger需要创建一个配置类，并开启swagger配置
 * ps：swagger和 swagger2 不能通用
 *
 * 步骤：
 * 1.将swaggerConfig注册到ioc容器中
 * 2.开启swagger2功能
 * 3.运行项目，访问swagger-ui.html
 */
@Configuration // 就是@Component
@EnableSwagger2 // 开启swagger
public class Swagger2Config {
   
}

那我们要怎么更改swagger的默认配置呢？
先看 @EnableSwagger2

//
// Source code recreated from a .class file by IntelliJ IDEA
// (powered by Fernflower decompiler)
//

package springfox.documentation.swagger2.annotations;

import java.lang.annotation.Documented;
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
import org.springframework.context.annotation.Import;
import springfox.documentation.swagger2.configuration.Swagger2DocumentationConfiguration;

@Retention(RetentionPolicy.RUNTIME)
@Target({
   ElementType.TYPE})
@Documented
@Import({
   Swagger2DocumentationConfiguration.class}) // 导入指定类
public @interface EnableSwagger2 {
   
}

该类的注解上有==@Import({Swagger2DocumentationConfiguration.class})==，导入了 Swagger2DocumentationConfiguration.class 这个类，继续看一下这个类是干哈的。

//
// Source code recreated from a .class file by IntelliJ IDEA
// (powered by Fernflower decompiler)
//

package springfox.documentation.swagger2.configuration;

import ...

@Configuration // 该类是一个配置类
@Import({
   SpringfoxWebMvcConfiguration.class, SwaggerCommonConfiguration.class})
@ComponentScan(
    basePackages = {
   "springfox.documentation.swagger2.mappers"}
)
@ConditionalOnWebApplication
public class Swagger2DocumentationConfiguration {
   
    public Swagger2DocumentationConfiguration() {
   
    }

    @Bean
    public JacksonModuleRegistrar swagger2Module() {
   
        return new Swagger2JacksonModule();
    }

    @Bean
    public HandlerMapping swagger2ControllerMapping(Environment environment, DocumentationCache documentationCache, ServiceModelToSwagger2Mapper mapper, JsonSerializer jsonSerializer) {
   
        return new PropertySourcedRequestMappingHandlerMapping(environment, new