springboot项目中swagger2以及swagger2markup的用法

最新推荐文章于 2024-08-10 07:25:23 发布

Ltoto

最新推荐文章于 2024-08-10 07:25:23 发布

阅读量2.5k

点赞数 1

本文链接：https://blog.csdn.net/Ltoto/article/details/99867950

版权

本文介绍了如何在SpringBoot项目中启用Swagger2，通过@EnableSwagger2Doc注解启动并访问Swagger2 UI。同时，展示了如何利用Swagger2Markup生成本地文档，以及在测试类中使用该功能。在Controller中，详细说明了各注解的用法，如@RequestMapping、@ApiOperation和@ApiImplicitParams。此外，还提到了配置文件中静态资源的设置以及如何在有拦截器的情况下排除Swagger2请求。

摘要由CSDN通过智能技术生成

1.引入依赖
  pom.xml中需要两个依赖
  <1>启动swagger2的方式之一，用于启动swagger2的依赖，需要配合配置文件使用（另一种方式是引入springfox依赖，用配置类进行配置）
  
  <!--swagger2-->
  <dependency>
      <groupId>com.spring4all</groupId>
      <artifactId>swagger-spring-boot-starter</artifactId>
      <version>1.7.1.RELEASE</version>
  </dependency>

  <2>swagger2markup依赖，可将swagger2的API文档导出，在测试类中进行相关配置
  
  <!--swagger2markup-->
  <dependency>
      <groupId>io.github.swagger2markup</groupId>
      <artifactId>swagger2markup</artifactId>
      <version>1.3.1</version>
  </dependency>

2.启动swagger2

在入口函数上添加 @EnableSwagger2Doc 注解，启动主程序，访问http://localhost:8080/swagger-ui.ht