springboot集成swagger

最新推荐文章于 2024-11-19 14:38:25 发布

pmsyn

最新推荐文章于 2024-11-19 14:38:25 发布

阅读量167

点赞数

文章标签： spring boot swagger

本文链接：https://blog.csdn.net/rookiepm/article/details/131911955

版权

本文介绍了如何在SpringBoot项目中集成Swagger，包括添加依赖、配置启动器、创建DocketBean、定义API信息，以及使用@Api和@ApiOperation等注解来生成API文档。此外，还提到了如何查看生成的API文档和常用注解的用途。

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

springboot集成swagger

1.引入swagger依赖pom

		<!-- 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.7.0</version>
		</dependency>

2.启动配置

@Configuration
@EnableSwagger2
public class SwaggerConfig {
    @Bean
    public Docket createRestApi(){
        return new Docket(DocumentationType.SWAGGER_2).apiInfo(apiInfo())
                .select()
                .apis(RequestHandlerSelectors.any())
                .paths(Predicates.not(PathSelectors.regex("/error.*")))//错误路径不监控
        .build();
    }

    private ApiInfo apiInfo(){
        return new ApiInfoBuilder()
                .title("项目API文档")
                .build();
    }
}

3.在类中使用注解


@Api(tags = {"测试控制器说明"})
@RestController
@RequestMapping(value = "/test")
public class TestController {
    /* 方法注解 */
    @ApiOperation(value = "home方法说明")
    @GetMapping("/home")
    public String home() {
        return "返回值";
    }

    @ApiOperation(value = "post方法说明")
    @ApiImplicitParams({
            @ApiImplicitParam(name="id",value="主键"),
            @ApiImplicitParam(name="name",value="名称")
    })
    @PostMapping("/post")
    public void post(@RequestParam String id,@RequestParam String name) {

    }
}

4.api文档查看

在这里插入图片描述

5.常用注解

@API: 请求类的说明
@ApiOperation: 方法的说明
1 @ApiImplicitParams,@ApiImplicitParam: 方法参数的说明
@ApiResponses,@ApiResponse: 方法返回值的说明
@ApiModel: 用于 JavaBean 上面, 表示一个 JavaBean(如: 响应数据) 的信息

4.1 @ApiModelProperty: 用在 JavaBean 类的属性上面, 说明属性的含义