SpringBoot集成Swagger文档及自定义访问路径

Swagger文档框架

一、介绍

Swagger 是一个规范和完整的框架，用于生成、描述、调用和可视化 RESTful 风格的 Web 服务。总体目标是使客户端和文件系统作为服务器以同样的速度来更新。文件的方法，参数和模型紧密集成到服务器端的代码，允许API来始终保持同步。

二、SpringBoot使用默认集成

<dependency><groupId>io.springfox</groupId><artifactId>springfox-swagger2</artifactId><version>2.9.2</version><exclusions><exclusion><groupId>io.swagger</groupId><artifactId>swagger-annotations</artifactId></exclusion><exclusion><groupId>io.swagger</groupId><artifactId>swagger-models</artifactId></exclusion></exclusions>
</dependency><dependency><groupId>io.swagger</groupId><artifactId>swagger-annotations</artifactId><version>1.5.21</version>
</dependency><dependency><groupId>io.swagger</groupId><artifactId>swagger-models</artifactId><version>1.5.21</version>
</dependency><dependency><groupId>io.springfox</groupId><artifactId>springfox-swagger-ui</artifactId><version>2.9.2</version>
</dependency>

SwaggerConfig.java

@Configuration
@EnableSwagger2
public class SwaggerConfig {@Beanpublic Docket createRestApi() {return new Docket(DocumentationType.SWAGGER_2).apiInfo(apiInfo()).select().apis(RequestHandlerSelectors.basePackage("com.bxc.conformity.Swagger.DemoController"))
//                .paths(PathSelectors.regex("/App/.*|Thirdparty/.*")).paths(PathSelectors.regex("(/App/.*)|(/Thirdparty/.*)")).build().securitySchemes(securitySchemes()).securityContexts(securityContexts());}private List<ApiKey> securitySchemes() {List<ApiKey> apiKeyList = new ArrayList();apiKeyList.add(new ApiKey("Token", "token", "header"));return apiKeyList;}private List<SecurityContext> securityContexts() {List<SecurityContext> securityContexts = new ArrayList<>();securityContexts.add(SecurityContext.builder().securityReferences(defaultAuth()).forPaths(PathSelectors.regex("^(?!auth).*$")).build());return securityContexts;}List<SecurityReference> defaultAuth() {AuthorizationScope authorizationScope = new AuthorizationScope("global", "accessEverything");AuthorizationScope[] authorizationScopes = new AuthorizationScope[1];authorizationScopes[0] = authorizationScope;List<SecurityReference> securityReferences = new ArrayList<>();securityReferences.add(new SecurityReference("Token", authorizationScopes));return securityReferences;}private ApiInfo apiInfo() {
//     访问地址   http://localhost:8085/swagger-ui.htmlreturn new ApiInfoBuilder().title("接口文档 1.0.0").description("哈哈网络科技有限公司").version("1.0.0").build();}
}

使用

@Api(tags = "接口")
@RestController
@RequestMapping("/App")
public class SwController {@ApiOperation(value = "添加用户",notes = "  username        用户名 \n" +"passwd          密码 \n" +"company         公司名称 \n" +"child_number    子用户个数 \n")@PostMapping("/AddUser")public ResponseTemplate AddUser(@RequestBody@ApiParam(value = "{\"username\":\"test2\",\"passwd\":\"test\",\"company\":\"哈哈网络\",\"child_number\":10}")UserEntity user,HttpServletRequest request) {return ResSuccessTemplate.builder().build();}@ApiOperation("获取用户")@ApiImplicitParams({@ApiImplicitParam(name = "userid", value = "用户的id", required = true)})@GetMapping("/getUser/{userid}")public ResponseTemplate GetRootChildNumberMax(@PathVariable("userid") int userid) {return ResSuccessTemplate.builder().build();}
}

@ApiModel
@Mapper
public class UserEntity {@ApiModelProperty(hidden= true)private int id;@ApiModelProperty(hidden= true)private String username;@ApiModelProperty(value = "需求主题")private String age;@ApiModelProperty(hidden= true)@JsonProperty(access = JsonProperty.Access.WRITE_ONLY)private String passwd;}

二、SpringBoot集成并自定义Swagger访问路径

上面的集成后，访问地址为：http://localhost:8030/swagger-ui.html
在一些经过网关访问时要加上某个自定义地址，当然可以通过 spring.jersey.application-path来实现，但有些情况不好设置全局的地址时，就可以用下面方式。

下面将Swagger访问地址修改为：
http://localhost:8030/my/index.html

下载swagger-ui

https://github.com/swagger-api/swagger-ui/tree/v3.18.3

配置数据转发

@Controller
@RequestMapping("/my")
public class SwaggerController {@GetMapping("/v2/api-docs")public void  swagger(HttpServletRequest request, HttpServletResponse response){String url = "/v2/api-docs";System.out.println(url);try {request.getRequestDispatcher(url).forward(request,response);} catch (Exception e) {e.printStackTrace();}}}

将解压后打包好的dist文件夹改名称为my，并将修改后的文件夹复制到static下。
修改static/my/index.html

将 url: "https://petstore.swagger.io/v2/swagger.json"
修改为：url: "/my/v2/api-docs"

修改引用：

 <script src="/my/swagger-ui-bundle.js"> </script>
<script src="/my/swagger-ui-standalone-preset.js"> </script>

5. 重新打开项目便以生效。

SpringBoot集成Swagger文档及自定义访问路径相关推荐

SpringBoot 集成接口文档，老鸟们也被打脸了！
之前我在SpringBoot老鸟系列中专门花了大量的篇幅详细介绍如何集成Swagger,以及如何对Swagger进行扩展让其支持接口参数分组功能.详情可见:SpringBoot 如何生成接口文档,老鸟 ...
权限管理系统2—集成Swagger文档
(Swagger介绍及使用) Swagger用于多人协作中共享和及时更新API开发接口文档的问题 1. 引入包 <dependency>< ...
SpringBoot集成swagger生成在线接口文档
SpringBoot集成swagger生成在线接口文档集成maven依赖 <dependency><groupId>io.springfox</groupId>& ...
SpringBoot - 集成Swagger、Knif4j接口文档以及文档添加账号密码登录
文章目录集成Swagger.Knif4j 依赖配置演示集成Swagger.Knif4j 依赖 pom.xml <!-- 引入Knife4j的官方start包,Swagger2基于Spri ...
java附魔_给你的Swagger文档换套附魔皮肤吧
本文将为您描述给你的Swagger文档换套附魔皮肤吧,具体完成步骤:前言相信无论是前端或是后端的程序员对Swagger都不怎么陌生,没有用过应该也听说过 Swagger 是一个规范和完整的框架,用于 ...
【水滴石穿】SpringBoot 集成Swagger
SpringBoot 集成Swagger Swagger 可以使你的restful接口自动生成接口文档,方便查看与测试,下面是一些具体步骤: 1.引入swagger相关依赖 <dependenc ...
SpringBoot教程(十六) | SpringBoot集成swagger（全网最全）
一. 接口文档概述 swagger是当下比较流行的实时接口文文档生成工具.接口文档是当前前后端分离项目中必不可少的工具,在前后端开发之前,后端要先出接口文档,前端根据接口文档来进行项目的开发,双方开发 ...
使用 Swagger 文档化和定义 RESTful API
大部分 Web 应用程序都支持 RESTful API,但不同于 SOAP API--REST API 依赖于 HTTP 方法,缺少与 Web 服务描述语言(Web Services Descript ...
idea快速生成crud_Java / Spring：如何快速生成完整的Swagger文档CRUD REST API
idea快速生成crud 作为开发人员,我们在日常生活中经常面临的最繁琐的任务之一就是编写良好且易于理解的文档. 无论我们的文档只有几行来解释功能的核心功能,还是表明系统的来龙去脉的成熟文章都没关系. ...
swagger文档配置
swagger文档在springboot项目中使用已经非常广泛,作为api接口管理工具使用起来也很简单,只需要简单配置一下,就可以生成文档管理页面,在页面上管理查看api接口文档,以及进行接口调试等 ...