栏目分类:
子分类:
返回
名师互学网用户登录
快速导航关闭
当前搜索
当前分类
子分类
实用工具
热门搜索
名师互学网 > IT > 软件开发 > 后端开发 > Java

5 Swagger3 API信息配置结合SpringBoot2

Java 更新时间: 发布时间: IT归档 最新发布 模块sitemap 名妆网 法律咨询 聚返吧 英语巴士网 伯小乐 网商动力

5 Swagger3 API信息配置结合SpringBoot2

默认情况,显示的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;


@Configuration
public class Swagger3Config {

    
    @Bean
    public Docket createRestApi() {
        return new Docket(documentationType.OAS_30)  // 指定swagger3.0版本
                .apiInfo(createApiInfo());
    }

    
    @Bean
    public ApiInfo createApiInfo(){
        return new ApiInfo("Java1234 Swagger"
               ,"Java1234 Api documentation"
                ,"3.0"
                ,"http://www.java1234.vip"
                ,new Contact("小锋", "http://www.java1234.vip", "caofeng2012@126.com")
                ,"Apache 2.0"
                ,"http://www.apache.org/licenses/LICENSE-2.0"
                ,new ArrayList());
    }


}

重启项目,我们发现,APIInfo信息变了;

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

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

转载请注明:文章转载自 www.mshxw.com
本文地址:https://www.mshxw.com/it/274514.html
我们一直用心在做
关于我们 文章归档 网站地图 联系我们

版权所有 (c)2021-2022 MSHXW.COM

ICP备案号:晋ICP备2021003244-6号