swagger使用

WuWuII

已于 2023-11-30 14:34:56 修改

阅读量311

点赞数

CC 4.0 BY-SA版权

分类专栏： API工具文章标签： java

于 2021-03-17 20:27:00 首次发布

本文链接：https://blog.csdn.net/a3562323/article/details/114947200

API工具专栏收录该内容

2 篇文章

订阅专栏

本文详细介绍如何在Spring Boot项目中集成Swagger2实现API文档自动生成。包括添加依赖、配置类编写、控制器注解使用等步骤，并解决可能出现的错误。

摘要生成于 C知道，由 DeepSeek-R1 满血版支持，前往体验 >

文章目录

引入pom
配置类
controller
- 访问swagger界面
swagger常用注解
报错
- Failed to start bean 'documentationPluginsBootstrapper'; nested exception is java.lang.NullPointerException

引入pom

两个依赖

        <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>

配置类

@Configuration
@EnableSwagger2
public class SwaggerConfig {

    @Bean
    public Docket createRestApi() {
        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo())
                .select()
                //扫描com.wzw的所有controller
                .apis(RequestHandlerSelectors.basePackage("com.wzw"))
                .paths(PathSelectors.any())
                .build();
    }

    private ApiInfo apiInfo() {
        return new ApiInfoBuilder()
                .title("哈哈哈哈哈哈哈哈title")
                .description("哈哈哈哈哈哈哈哈description")
                .termsOfServiceUrl("哈哈哈哈哈哈哈哈termsOfServiceUrl")
                .contact("哈哈哈哈哈哈哈哈contact")
                .version("哈哈哈哈哈哈哈哈version")
                .build();
    }

}

controller

@RestController
@Api(tags = "测试接口")
@RequestMapping("/test")
public class TestController {

    @ApiOperation(value="hello的value",notes="hello的notes")
    @RequestMapping("/hello")
    @ApiImplicitParams({
            @ApiImplicitParam(name="id的name",value="id的value"),
            @ApiImplicitParam(name="name的name",value="name的value")
    })
    public String hello(String id,String name){
        return "hello";
    }

    @RequestMapping("/aaa")
    public String aaa(){
        return "hello";
    }


}

访问swagger界面

http://localhost:8080/swagger-ui.html
在这里插入图片描述

swagger常用注解

这些注解相当于给swagger界面的接口参数的注释

@Api

@Api用在controller上

@RestController
@Api(tags = "测试接口")
@RequestMapping("/test")
public class TestController {

效果：
在这里插入图片描述

@ApiOperation

@ApiOperation用在方法上

    @ApiOperation(value="hello的value",notes="hello的notes")
    @RequestMapping("/hello")
    public String hello(String id,String name){
        return "hello";
    }

效果：
在这里插入图片描述

@ApiImplicitParam

@ApiImplicitParam用在参数上

    @ApiOperation(value="hello的value",notes="hello的notes")
    @RequestMapping("/hello")
    @ApiImplicitParams({
            @ApiImplicitParam(name="id的name",value="id的value"),
            @ApiImplicitParam(name="name的name",value="name的value")
    })
    public String hello(String id,String name){
        return "hello";
    }

效果：
在这里插入图片描述

报错

Failed to start bean ‘documentationPluginsBootstrapper’; nested exception is java.lang.NullPointerException

springboot版本和swagger2版本不符。

降低springboot版本，
或者配置文件增加参数

spring:
	mvc:
		pathmatch:
			matching-strategy: ant_path_matcher