这篇文章主要介绍SpringBoot如何集成Swagger3,文中介绍的非常详细,具有一定的参考价值,感兴趣的小伙伴们一定要看完!
1, Swagger 是一个规范和完整的文档框架,
用于生成、描述、调用和可视化 RESTful 风格的 Web 服务文档
官方网站:https://swagger.io/
2,使用swagger要注意的地方:
在生产环境中必须关闭swagger,
它本身只用于前后端工程师之间的沟通,
可以专门使用一台内部服务器来展示ui供访问,
即使在这上面要做好安全措施
3, 因为swagger3.0.0已发布,本文使用了最新版
如果有还在用2.x版本的请参考时注意区分
pom.xml 集成Swagger3依赖
<!-- swagger3 接口文档生成器 -->
<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-boot-starter</artifactId>
<version>3.0.0</version>
<exclusions>
<exclusion>
<groupId>org.springframework.plugin</groupId>
<artifactId>spring-plugin-core</artifactId>
</exclusion>
<exclusion>
<groupId>org.springframework.plugin</groupId>
<artifactId>spring-plugin-metadata</artifactId>
</exclusion>
</exclusions>
</dependency>
Swagger3 配置对象定义
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.oas.annotations.EnableOpenApi;
import springfox.documentation.service.ApiInfo;
import springfox.documentation.service.Contact;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;
@Configuration
@EnableOpenApi
public class Swagger3Config {
@Bean
public Docket createRestApi() {
return new Docket(DocumentationType.OAS_30)
.apiInfo(apiInfo())
.select()
.apis(RequestHandlerSelectors.basePackage("com.digipower.controller"))
.paths(PathSelectors.any())
.build();
}
private ApiInfo apiInfo() {
return new ApiInfoBuilder().title("在奋斗的大道上 - 微信预约查档系统").termsOfServiceUrl("https://blog.csdn.net/zhouzhiwengang")
.description("API接口")
.contact(new Contact("https://blog.csdn.net/zhouzhiwengang","",""))
.version("3.0").build();
}
}
SpringBoot 集成Swagger3 接口文档效果截图
SpringBoot 访问Swagger3接口文档地址
默认接口访问地址:http://192.168.0.1:5988/swagger-ui/
@ApiModel用于类上面说明功能
@ApiModelProperty用于字段上说明功能
示列截图:
@Api用来指定一个controller中的各个接口的通用说明
@ApiOperation用来说明一个方法
@ApiImplicitParams:用来包含多个包含多个 @ApiImplicitParam
@ApiImplicitParam:用来说明一个请求参数
示列截图:
温馨提示:针对任何请求参数结构说明,请一定记得要添加@ApiParam 标签,如果不添加@ApiParam标签,在Swagger3文档中针对参数结构说明就是空
以上是“SpringBoot如何集成Swagger3”这篇文章的所有内容,感谢各位的阅读!希望分享的内容对大家有帮助,更多相关知识,欢迎关注亿速云行业资讯频道!
亿速云「云服务器」,即开即用、新一代英特尔至强铂金CPU、三副本存储NVMe SSD云盘,价格低至29元/月。点击查看>>
免责声明:本站发布的内容(图片、视频和文字)以原创、转载和分享为主,文章观点不代表本网站立场,如果涉及侵权请联系站长邮箱:is@yisu.com进行举报,并提供相关证据,一经查实,将立刻删除涉嫌侵权内容。