SpringBoot项目中使用Swagger2及注解解释（详细）

nianyuw

已于 2022-08-26 23:15:23 修改

阅读量1.7w

点赞数 18

于 2022-08-14 00:41:08 首次发布

本文链接：https://blog.csdn.net/m0_61820867/article/details/126326646

版权

本文档详细介绍了如何在SpringBoot项目中集成Swagger2，包括添加依赖、启用Swagger2、配置SwaggerConfig以及Swagger2的各种注解用法，帮助开发者快速生成API文档。

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

SpringBoot项目中使用Swagger2及注解解释

这里写目录标题

- - SpringBoot项目中使用Swagger2及注解解释

一、导入Swagger坐标依赖

<dependency>
    <groupId>io.springfox</groupId>
    <artifactId>springfox-swagger2</artifactId>
    <version>${swagger.version}</version>
</dependency>

<dependency>
    <groupId>io.springfox</groupId>
    <artifactId>springfox-swagger-ui</artifactId>
    <version>${swagger.version}</version>
</dependency>

其中版本最常用2.9.2

二、在spring启动类添加注解@EnableSwagger2

@EnableSwagger2是springfox提供的一个注解，代表swagger2相关技术开启。会扫描当前类所在包，及子包中所有类型的swagger相关注解，做swagger文档的定制

三、启动项目，查看swaggerui.html界面

这是我开发项目的地址，访问后可以看到swaggerui.html

http://localhost:9527/swagger-ui.html

点击try it out可以输入对应的参数查看返回结果

四，编写SwaggerConfig配置文件

@EnableSwagger2
@Configuration
public class SwaggerConfig {
   
    @Autowired
    private ApplicationContext applicationContext;

    private Contact contact = new Contact("NIUA","localhost:8080/swagger-ui.html", "1053288979@qq.com");

    @Bean
    public Docket createRestApi() {