SpringBoot集成swagger 注解使用步骤
Posted 小吴吃肉啦~
tags:
篇首语:本文由小常识网(cha138.com)小编为大家整理,主要介绍了SpringBoot集成swagger 注解使用步骤相关的知识,希望对你有一定的参考价值。
Swagger
一般用于测试接口 使用最少实现逻辑与远程服务进行交互 用于controller层与为底层编程所实现的接口类似, 与Postman一样
Swagger 是一个规范且完整的框架,用于生成、描述、调用和可视化 RESTful 风格的 Web 服务。
优点: 1. 生产在线接口文档 2.方便测试
第一步 导入依赖
<!--swagger-->
<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-swagger2</artifactId>
<version>2.7.0</version>
</dependency>
<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-swagger-ui</artifactId>
<version>2.7.0</version>
</dependency>
创建公共模块,整合swagger,为了所有模块都可使用
在SwaggerConfig中 配置插件
package com.atguigu.servicebase;
import com.google.common.base.Predicates;
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.service.ApiInfo;
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 //swagger注解
public class SwaggerConfig
@Bean
public Docket webApiConfig()
return new Docket(DocumentationType.SWAGGER_2)
.groupName("webApi")
.apiInfo(webApiInfo())
.select()
.paths(Predicates.not(PathSelectors.regex("/admin/.*")))
.paths(Predicates.not(PathSelectors.regex("/error.*")))
.build();
private ApiInfo webApiInfo()
return new ApiInfoBuilder()
.title("网站-课程中心API文档")
.description("本文档描述了课程中心微服务接口定义")
.version("1.0")
.contact(new Contact("java", "http://atguigu.com", "1123@qq.com"))
.build();
运行 http://localhost:8001/swagger-ui.html
应为我端口号设置的8001 (没有设置的话== 默认8080==)
优化 相当于在swagger 上的方法 显示 该接口是干什么的
定义在类上:@Api
定义在方法上:@ApiOperation
定义在参数上:@ApiParam
下面全红的 代码和注解 对应 最后图片上的 全红的地方
ApiOperation
定义在参数上:@ApiParam
以上是关于SpringBoot集成swagger 注解使用步骤的主要内容,如果未能解决你的问题,请参考以下文章