5 Swagger3 API信息配置结合SpringBoot2

Posted 2022-12-04 java1234_小锋

默认情况，显示的API信息如下：

通过源码，我们可以看到：这个信息是通过springfox.documentation.service.ApiInfo.java类来构造的；

最终通过springfox.documentation.spring.web.plugins.Docket.java类的构造方法传入ApiInfo类来最终构造；

我们要修改API信息默认配置的话，可以通过新建一个com.java1234.config.Swagger3Config.java配置类，重写ApiInfo实现，以及重写Docket实现并且设置apiInfo；

package com.java1234.config;

import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import springfox.documentation.service.ApiInfo;
import springfox.documentation.service.Contact;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;

import java.util.ArrayList;

/**
 * @author java1234_小锋
 * @site www.java1234.com
 * @company 南通小锋网络科技有限公司
 * @create 2021-09-21 10:42
 */
@Configuration
public class Swagger3Config 

    /**
     * 配置swagger的Docket bean
     * @return
     */
    @Bean
    public Docket createRestApi() 
        return new Docket(DocumentationType.OAS_30)  // 指定swagger3.0版本
                .apiInfo(createApiInfo());
    

    /**
     * 配置swagger的ApiInfo bean
     * @return
     */
    @Bean
    public ApiInfo createApiInfo()
        return new ApiInfo("Java1234 Swagger"
               ,"Java1234 Api Documentation"
                ,"3.0"
                ,"http://www.java1234.vip"
                ,new Contact("小锋", "http://www.java1234.vip", "[e-mail]")
                ,"Apache 2.0"
                ,"http://www.apache.org/licenses/LICENSE-2.0"
                ,new ArrayList());
    

重启项目，我们发现，APIInfo信息变了；

这个API信息主要作用是让前端开发人员看的，谁开发的接口，或者哪个小组负责，有问题方便联系沟通；

说明：这个是锋哥的Swagger3备课笔记，等备课完，会发布配套的视频教程，如有需要，可以先加锋哥WX：java1239 欢迎白嫖