首页
学习
活动
专区
工具
TVP
发布
精选内容/技术社群/优惠产品,尽在小程序
立即前往

Swagger2更改Swagger Ui的基本路径

要更改Swagger UI的基本路径,您可以通过配置Swagger2来实现。以下是一般的步骤:

  1. 创建一个配置类:在您的Spring Boot项目中,创建一个配置类,用于配置Swagger2。您可以使用@Configuration注解标记该类。
  2. 添加Swagger2相关的依赖:确保您的项目中已经添加了Swagger2相关的依赖项。例如,对于Maven项目,您可以在pom.xml文件中添加以下依赖:
代码语言:javascript
复制
<dependency>
    <groupId>io.springfox</groupId>
    <artifactId>springfox-swagger2</artifactId>
    <version>2.9.2</version>
</dependency>
<dependency>
    <groupId>io.springfox</groupId>
    <artifactId>springfox-swagger-ui</artifactId>
    <version>2.9.2</version>
</dependency>
  1. 配置Swagger2:在配置类中,使用@EnableSwagger2注解启用Swagger2,并创建一个Docketbean来配置Swagger2的行为。在Docket的构造函数中,您可以指定Swagger UI的基本路径。
代码语言:javascript
复制
@Configuration
@EnableSwagger2
public class SwaggerConfig {

    @Bean
    public Docket api() {
        return new Docket(DocumentationType.SWAGGER_2)
                .pathMapping("/your-base-path") // 设置Swagger UI的基本路径
                .select()
                .apis(RequestHandlerSelectors.basePackage("com.example.controller"))
                .paths(PathSelectors.any())
                .build();
    }
}

在上述示例中,.pathMapping("/your-base-path")指定了Swagger UI的基本路径。您可以将/your-base-path替换为您想要的基本路径。

  1. 启动应用程序:重新启动您的应用程序,并访问Swagger UI以查看更改后的基本路径是否生效。
页面内容是否对你有帮助?
有帮助
没帮助

相关·内容

Spring Boot 自定义 Swagger2 请求 URL 路径两种方法

文章目录 前言 方法一:修改应用根路径 方法二:引入 Swagger2 前端代码 总结 前言 首先,把 Swagger2 依赖引进来: <!...://localhost:端口/swagger-ui.html 如果我们想要修改上述请求路径,则需要进行一些修改。...在这里,以 Spring Boot 项目为例,给出两种自定义 Swagger2 请求 URL 路径方法。...但与第一种方法不同,使用第二种方法配置完之后,Swagger2 访问路径应该为: http://localhost:端口/selfpath/swagger/index.html 其中,我们自定义路径为...特别地,在swagger-ui 3.0 版本之后,该项目调整了目录结构,已经没有dist目录了。 参考资料: Swagger请求更改请求url地址

10.5K31

spring boot 下swagger2 使用

ClassName cn.saytime.Swgger2 * @Description * @date 2017-07-10 22:12:31 */ @Configuration public class Swagger2...API在swagger-ui显示顺序 @ApiOperation() 用于方法 在指定(路由)路径上,对一个操作或HTTP方法进行描述。...具有相同路径不同操作会被归组为同一个操作对象。不同HTTP请求方法及路径组合构成一个唯一操作。此注解属性有: value:对操作简单说明,长度为120个字母,60个汉字。...主要属性有: value:model别名,默认为类名 description:对model详细描述 ** @ApiModelProperty() 用于model类属性** 表示对model属性说明或者数据操作更改...@ApiImplicitParams() 用于方法 该注解可以包含多个 @ApiImplicitParam swagger2 如何匹配多个controller @Bean public Docket

58110

13.9 SpringBoot集成Swagger2中遇到问题13.9 SpringBoot集成Swagger2中遇到问题

13.9 SpringBoot集成Swagger2中遇到问题 我们在使用SpringBoot集成Swagger2中,访问:http://127.0.0.1:8188/swagger-ui.html 问题描述...后台报错: No handler found for GET /swagger-ui.html 2.显示Swagger空白页面: ?...我们在访问http://127.0.0.1:8188/swagger-ui.html 时,这个swagger-ui.html相关所有前端静态文件都在springfox-swagger-ui-2.6.1...Spring Boot自动配置本身不会自动把/swagger-ui.html这个路径映射到对应目录META-INF/resources/下面。我们加上这个映射即可。...完整Spring Boot集成Swagger2构建自动化Rest API文档工程示例,源码参考: 当然,为了更加方便使用SpringBoot集成swagger,这个工作可以直接通过定制swagger-starter

2.4K30

接口文档:第二章:使用Swagger接口文档在线自动生成

花了二天搞了一个比较简洁接口文档,浪费时间不说,写也不太好,不满意。这一章使用Swagger接口文档在线自动生成省下不少时间,而且很规范。 导入Maven 版本号请根据实际情况自行更改。...配置类 在Application.java同级创建Swagger2配置类Swagger2 package com.swaggerTest; import org.springframework.context.annotation.Bean...) 增加API相关信息 * 通过select()函数返回一个ApiSelectorBuilder实例,用来控制哪些接口暴露给Swagger来展现, * 本例采用指定扫描路径来定义指定要建立...(这些基本信息会展现在文档页面中) * 访问地址:http://项目实际地址/swagger-ui.html * @return */ private ApiInfo...之后,apiInfo() 用来创建该Api基本信息(这些基本信息会展现在文档页面中)。

83320

SpringBoot集成Swagger2生成接口文档,妈妈再也不用担心我写API文档了

在现在开发过程中,基本已经全部采用API接口方式进行系统开发了,于是乎,在此过程中,一个好 API 文档便成为了后台与前台进行沟通与开发关键桥梁。...成员方法 createRestApi 函数创建 Docket Bean 之后,apiInfo() 用来创建该 Api 基本信息(这些基本信息会展现在文档页面中)。...select() 函数返回一个 ApiSelectorBuilder 实例用来控制哪些接口暴露给 Swagger 来展现,本例采用指定扫描路径来定义,Swagger 会扫描该包下所有 Controller...需要注意是,如已添加路径拦截器,需通过 .excludePathPatterns("/swagger-resources/**", "/webjars/**", "/v2/**", "/swagger-ui.html.../**") 对 swagger 路径放行。

1.2K20

Swagger2使用教程

Swagger2使用教程 1、简介 Swagger 是一套基于 OpenAPI 规范(OpenAPI Specification,OAS)构建开源工具,后来成为了 Open API 标准主要定义者。...Swagger 主要包含了以下三个部分: 名称 说明 Swagger Editor 基于浏览器编辑器,我们可以使用它编写我们 OpenAPI 规范 Swagger UI 它会将我们编写 OpenAPI...springfox-swagger2:这个组件功能用于帮助我们自动生成描述APIjson文件 springfox-swagger-ui:就是将描述APIjson文件解析出来,用一种更友好方式呈现出来...文档生成 * 路径:ip:port/swagger-ui.html */ @Configuration public class Swagger2Configuration { //...对于生产环境,开启swagger可能会导致api暴露而产生安全问题。并且要注意扫描包位置更改

99410

Spring boot集成模板引擎swagger2实现

Spring boot 集成模板引擎实现web应用(一) ① 静态资源访问 静态资源 js, css, html, 图片,音视频 静态资源路径 系统可以直接访问路径,且路径所有文件均可被用户直接读取...当然也可以修改这个路径,通过配置文件属性,这个在上次配置文件里面有详细解释配置里面有。 集成Thymeleaf步骤 1.修改pom.xml, 增加如下依赖。...RESTful API ② 集成Swagger2步骤 1.修改pom.xml, 添加Swagger2依赖 io.springfox...指定扫描包下面的注解 .paths(PathSelectors.any()) .build(); } // 创建api基本信息...UI界面:http://localhost:8881/swagger-ui.html PS:今天说了简单模板引擎和swagger2介绍,只是功能介绍详细细节没有做阐述。

43240

『互联网架构』软件架构-Spring boot集成模板引擎swagger2实现(87)

(一)Spring boot 集成模板引擎实现web应用 静态资源访问 静态资源 js, css, html, 图片,音视频 静态资源路径 系统可以直接访问路径,且路径所有文件均可被用户直接读取。...当然也可以修改这个路径,通过配置文件属性,这个在上次配置文件里面有详细解释配置里面有。 ? 集成Thymeleaf步骤 1.修改pom.xml, 增加如下依赖。...))// 指定扫描包下面的注解 .paths(PathSelectors.any()) .build(); } // 创建api基本信息...UI界面:http://localhost:8881/swagger-ui.html ?...PS:今天说了简单模板引擎和swagger2介绍,只是功能介绍详细细节没有做阐述。先从会用开始吧,具体细节还是看官方api更详细,这里只是从入门开始说起。

45430

Swagger2介绍+与SpringMVC整合

Swagger UI - 将OpenAPI规范呈现为交互式API文档。 Swagger Codegen - 从OpenAPI规范生成服务器存根和客户端库。...再通过createRestApi函数创建DocketBean之后,apiInfo()用来创建该Api基本信息(这些基本信息会展现在文档页面中)。...select()函数返回一个ApiSelectorBuilder实例用来控制哪些接口暴露给Swagger来展现,本例采用指定扫描路径来定义,Swagger会扫描该包下所有Controller定义API...对api资源描述 basePath 基本路径可以不配置 position 如果配置多个Api 想改变显示顺序位置 produces For example, “application/json,...,使用方式 属性名称 备注 value url路径值 tags 如果设置这个值、value值会被覆盖 description 对api资源描述 basePath 基本路径可以不配置 position

5.4K10

SpringBoot整合Swagger2,再也不用维护接口文档了!

前后端分离后,维护接口文档基本上是必不可少工作。一个理想状态是设计好后,接口文档发给前端和后端,大伙按照既定规则各自开发,开发好了对接上了就可以上线了。...还好,有一些工具可以减轻我们工作量,Swagger2就是其中之一,至于其他类似功能但是却收费软件,这里就不做过多介绍了。本文主要和大伙来聊下在Spring Boot中如何整合Swagger2。...,然后配置一个Docket Bean,这个Bean中,配置映射路径和要扫描接口位置,在apiInfo中,主要配置一下Swagger2文档网站信息,例如网站title,网站描述,联系人信息,使用协议等等...如此,Swagger2就算配置成功了,非常方便。 此时启动项目,输入http://localhost:8080/swagger-ui.html,能够看到如下页面,说明已经配置成功了: ?...当然还有一种可能就是这里参数为path,表示参数放在路径中传递,例如根据id查询用户接口: ? 当然,除了这些之外,还有一些响应值注解,都比较简单,小伙伴可以自己摸索下。

88920

SpringBoot整合Springfox-Swagger2「建议收藏」

前言 不管Spring Boot整合还是SpringMVC整合Swagger基本类似,重点就在于配置Swagger,它精髓所在就在于配置。...启动项目可访问http://localhost:8080/swagger-ui.html 可以看到swagger界面,如下; 4、配置Swagger 不管是Spring Boot整合还是SpringMVC...整合Swagger基本类似,重点就在于配置Swagger,它精髓所在就在于配置,这很关键。...")) //paths: 这里是控制哪些路径api会被显示出来,比如下方参数就是除了/user以外其它路径都会生成api文档 .paths..._2) .groupName("组三") // 省略配置.... } 4.4、Swagger2常用注解 讲第三部分和第四部分前,非常有必要先了解swagger2常用注解,用注解的话

1.1K10
领券