Springboot整合swagger2，swagger2的简单使用，Java web使用swagger2

最新推荐文章于 2024-08-17 12:33:42 发布

小星博博

最新推荐文章于 2024-08-17 12:33:42 发布

阅读量1.2k

点赞数 31

分类专栏： Java 文章标签： swagger2

本文链接：https://blog.csdn.net/baidu_39105563/article/details/113872552

版权

Java 专栏收录该内容

4 篇文章 0 订阅

订阅专栏

本文详细介绍了如何在SpringBoot项目中集成Swagger，包括添加依赖、配置SwaggerConfig、标注API和类，最终实现API文档的生成与访问。通过实例演示了如何使用@Api和@ApiOperation进行接口描述。

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

开发环境：IntelliJ IDEA ，win10
开发框架：springboot
开发语言：java

1、在pom.xml中引入依赖

<!--      swagger依赖-->
<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>

2.在config包下创建SwaggerConfig类

import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import springfox.documentation.builders.ApiInfoBuilder;
import springfox.documentation.builders.PathSelectors;
import springfox.documentation.builders.RequestHandlerSelectors;
import springfox.documentation.service.Contact;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;
import springfox.documentation.swagger2.annotations.EnableSwagger2;

@Configuration
@EnableSwagger2
public class SwaggerConfig {
    @Bean
    public Docket createRestApi() {
        return new Docket(DocumentationType.SWAGGER_2)
                .pathMapping("/")
                .select()
                .apis(RequestHandlerSelectors.basePackage("com.nvn.controller"))
                .paths(PathSelectors.any())
                .build().apiInfo(new ApiInfoBuilder()
                        .title("SpringBoot整合Swagger")
                        .description("SpringBoot整合Swagger，详细信息......")
                        .version("1.0")
                        .contact(new Contact("标题：","blog.csdn.net","aaa@gmail.com"))
                        .license("The Apache License")
                        .licenseUrl("http://www.baidu.com")
                        .build());
    }
}

3、访问localhost:8989/swagger-ui.html 即可，如下
在这里插入图片描述 4、使用@Api(tags = “User”) 修改类描述

@Api(tags = "User")
public class UserController {
	//略...
}

5、使用@ApiOperation(value = “登录”,notes = “描述：用户登录api接口”)修改方法描述。
notes中可填写html5代码

@PostMapping("login")
@ApiOperation(value = "登录",notes = "<font color='green'>描述：</font>用户登录api接口")
public JsonResult login(String accountId, String password, HttpServletRequest request, HttpServletResponse response) {
        //略
}