Swagger屏蔽某些接口显示的操作
更新时间:2021年06月25日 14:13:54 作者:zhuwei_clark
这篇文章主要介绍了Swagger屏蔽某些接口显示的操作,具有很好的参考价值,希望对大家有所帮助。如有错误或未考虑完全的地方,望不吝赐教
Swagger屏蔽某些接口显示
首先说下为什么要屏蔽,因为某些接口是针对内部服务调用的,不需要进行对接。显示出来的话:
1、容易混淆
2、容易暴露相关接口内容
其实屏蔽的话比较简单,主要是注解:
@ApiIgnore
@RequestMapping("/wx/back")
@ApiIgnore
public String wxBack(HttpServletRequest request){
return payService.back(ParamUtil.getXmlString(request),"zjcOrderService");
}
这样在Swagger上面就不会显示这个接口了
如果这个接口是在类上加的,整个类就不会显示了
Swagger Ui只显示部分接口
Swagger UI默认显示所有接口,连endpoint,jpa restful等接口也会显示
可以通过一下配置:
@Configuration
@EnableSwagger2
public class SwaggerConfig {
@Bean
public Docket api(){
return new Docket(DocumentationType.SWAGGER_2)
.select()
.apis(RequestHandlerSelectors.basePackage("包名"))
.paths(PathSelectors.any())
.build();
}
}
配置上你controller的包路径,就会只显示你包下面的接口
以上为个人经验,希望能给大家一个参考,也希望大家多多支持脚本之家。
相关文章
springboot整合jquery和bootstrap框架过程图解
这篇文章主要介绍了springboot整合jquery和bootstrap框架过程图解,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友可以参考下2019-12-12
详解SpringBoot构建的Web项目如何在服务端校验表单输入
这篇文章主要介绍了详解SpringBoot构建的Web项目如何在服务端校验表单输入,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧2019-10-10


最新评论