swagger的使用
Posted yxyuanxiang
tags:
篇首语:本文由小常识网(cha138.com)小编为大家整理,主要介绍了swagger的使用相关的知识,希望对你有一定的参考价值。
介绍:
前后端分离开发模式中,api文档是最好的沟通方式。
Swagger 是一个规范和完整的框架,用于生成、描述、调用和可视化 RESTful 风格的 Web 服务。
总结:
目前使用到swagger的测试功能,可以替代postman进行 各种请求方式 的api接口测试
项目中使用:
1 引入依赖
<!--lombok用来简化实体类:需要安装lombok插件-->
<dependency>
<groupId>org.projectlombok</groupId>
<artifactId>lombok</artifactId>
<scope>provided </scope>
</dependency>
2 配置类中注册
@Configuration
@EnableSwagger2
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("Helen", "http://atguigu.com", "55317332@qq.com"))
.build();
}
}
以上是关于swagger的使用的主要内容,如果未能解决你的问题,请参考以下文章
使用 Swashbuckle V5 从代码生成 swagger.json