首页 > 其他分享 >Swagger配置

Swagger配置

时间:2024-03-13 16:24:43浏览次数:18  
标签:basePackage swagger title 配置 controller version 文档 Swagger

一定一定要注意各个模块的版本,否则会直接启动不起来或者报各种各样奇怪的错误!!!!

版本:SpringBoot 2.3.12 Mybatis 8.0.31 swagger 2.7.0

导入Maven依赖

      <dependency>
          <groupId>io.springfox</groupId>
          <artifactId>springfox-swagger2</artifactId>
          <version>2.7.0</version>
      </dependency>
      <dependency>
          <groupId>io.springfox</groupId>
          <artifactId>springfox-swagger-ui</artifactId>
          <version>2.7.0</version>
      </dependency>

配置application.yml文档

swagger:
  basePackage: com.pickle.controller
  title: pickle
  version: V1.0

编写配置类

@Configuration
@EnableSwagger2
@ConfigurationProperties(prefix = "swagger")
public class SwaggerConfig {
    @Value("${basePackage}")
    private String basePackage;  //controller所在的包
    @Value("${title}")
    private String title;//当前文档的标题
    @Value("${version}")
    private String version; //当前文档的版本
    @Bean
    public Docket createRestApi(){
        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo()) //指定构建api文档的详细信息的方法:apiInfo()
                .select()
                //指定要生成api接口的包路径,这里把controller作为包路径,生成controller中的所有接口
                .apis(RequestHandlerSelectors.basePackage(basePackage))
                .paths(PathSelectors.any())
                .build();
    }
    /*
      构建api文档的详细信息
     */
    private ApiInfo apiInfo(){
        return new ApiInfoBuilder()
                .title(title) //设置标题
                .version(version) //设置版本
                .build();
    }
}

标签:basePackage,swagger,title,配置,controller,version,文档,Swagger
From: https://www.cnblogs.com/poteitoutou/p/18070547

相关文章

  • Spring Boot 2.x中配置文件加载顺序分析
    一般springboot2.x的配置有多种方式,如resources文件夹中可以定义bootstrap.yml(或bootstrap.properties)、application.yml(或application.properties)、配置中心(如nacos),那么它们加载顺序是怎样的,如何使用?bootstrap.yml:首先加载bootstrap.yml(或bootstrap.properties)。这个......
  • 海康摄像头GB28181语音喊话/双向喊话的配置以及海康摄像头如何在公网GB28181喊话
    @目录1、背景2、准备2.1、服务端必备条件(注意)2.2、准备语音对讲设备2.2.1、不支持跨网对讲示例2.2.2、支持跨网对讲示例3、开启音频开始对讲4、搭建GB28181视频直播平台1、背景GB28181支持国标协议的设备,通过GB28181注册接入到国标视频平台后。视频平台在某些情况下需要喊话摄......
  • 4.MAC平台Python的下载、安装(含Python2.7+Python3.12双版本环境变量配置)——《跟老吕
    4.MAC平台Python的下载、安装(含Python2.7+Python3.12双版本环境变量配置)——《跟老吕学Python编程》)——跟老吕学Python编程一、下载MAC版Python1.Python官网2.MAC版Python下载网址二、在MAC安装Python1.在MAC安装Python2.阅读Python重要信息3.同意Python许可4.确认同意......
  • 如何配置极狐GitLab Runner Cache 缓存
    本文作者:徐晓伟GitLab是一个全球知名的一体化DevOps平台,很多人都通过私有化部署GitLab来进行源代码托管。极狐GitLab是GitLab在中国的发行版,专门为中国程序员服务。可以一键式部署极狐GitLab。极狐GitLabRunnerCache缓存支持S3标准协议,如:OSS、OOS等等支持S3......
  • Idea Project :一个正确配置 (调整Maven服务器后)
    配置Maven环境(FileSettings)MavenMavenrunnerJavaComplier配置ProjectStructureSDKProjectModuleuploading-image-281165.png......
  • [C++]c++ 在项目cpp文件中直接用#pragma comment语句引入,无需配置属性表
    使用语句添加引入库的好处就是无需配置多个属性表,不管是debug模式还是release模式,不管是64位还是32位,几行代码通吃。相对路径:#ifdef_M_X64#pragmacomment(lib,"../../../VC++/DVPCamera64.lib")#else#pragmacomment(lib,"../../../VC++/DVPCamera32.lib")#endif绝......
  • Qt5.12配置OpenCV教程
    在开发图像处理和计算机视觉应用时,QT和OpenCV是两个不可或缺的工具。QT为我们提供了丰富的图形界面设计功能,而OpenCV则提供了强大的图像处理算法。那么,如何将这两者完美结合呢?本文将为你详细解析QT5.12与OpenCV的配置过程,让你轻松上手!一、软件下载1、QT 5.12.9下载地址:......
  • 新版idea配置maven注意点!!
    1.maven配置首先是按要求配置了maven,关闭所有项目->自定义->所有设置配置完成之后发现新建项目下方还是显示从官方源下载maven包装器,而且在项目中出现这个配置文件可以通过更改解决,也可以在本地更改他下载的maven的目录更改setting配置到本地仓库和国产源,这样可以减少资源下......
  • windows 配置 docker
    安装dockerdesktop安装后修改路径在Microsoftstore安装Linux的任意版本安装后需要将Linux迁移到其他盘,避免减少c盘空间。开发时,项目放在Linux子系统目录下,避免文件系统不一致导致文件修改时不会触发监听事件。docker中将安装的Linux选为默认系统VScode安......
  • 39_配置redis集群
    配置redis集群三主三从集群设置Master1(6381)Master2(6382)Master3(6383)Slave1(6384)Slave2(6385)Slave3(6386)拉取镜像启动容器dockerpullredis:6.0.8dockerrun-d--nameredis-node-1--nethost--privileged=true-v/dataredis:6.0.8--cluster-en......