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的包路径,就会只显示你包下面的接口

以上为个人经验,希望能给大家一个参考。

猜你在找的Swagger屏蔽某些接口显示的操作相关文章

了解决swagger2.9.2接口文档显示的问题,具有很好的参考价值,希望对大家有所帮助。如有错误或未考虑完全的地方,望不吝赐教
上篇文章记录自定义切面,下边记录使用注解来编写自定义切面,文中有非常详细的介绍及代码示例,需求的大佬可以参考下
了swagger2隐藏在API文档显示某些参数的操作,具有很好的参考价值,希望对大家有所帮助。如有错误或未考虑完全的地方,望不吝赐教
今天给大家带来的是关于Springboot基础的相关知识,文章围绕着Springboot的基础知识及用法展开,文中有非常详细的介绍及代码示例,需求的大佬可以参考下
今天给大家带来的还是关于springboot的相关知识,文章围绕着springboot集成Mybatis的详细教程展开,文中有非常详细的介绍及代码示例,需求的大佬可以参考下
Java生态圈中有很多处理JSON和XML格式化的类库,Jackson是其中比较著名的一个。虽然JDK自带了XML处理类库,但是相对来说比较低级,使用本文介绍的Jackson等高级类库处
今天给大家带来的是关于Java的相关知识,文章围绕着java注解的使用展开,文中有非常详细的介绍及代码示例,需求的大佬可以参考下
了Sentinel Dashboard限流规则保存方式,具有很好的参考价值,希望对大家有所帮助。如有错误或未考虑完全的地方,望不吝赐教
Spring是一个轻量级的控制反转(IoC)和面向切面(AOP)的容器(框架),Spring使用基本的JavaBean来完成以前只可能由EJB完成的事情,本文给大家介绍spring概述和快速构建方
mybatsi中Mapper和xml文件之间有很多约定俗称的规则,比如名称匹配,包扫描,别名等,这些规则是什么。如果想更加灵活,该如何配置呢?今天就给大家讲一下如何配置mybatsi的x
这篇文章主要为大家详细介绍了Java多线程实现多人聊天室功能,文中示例代码介绍的非常详细,具有一定的参考价值,感兴趣的小伙伴们可以参考一下
了spring cloud gateway 修改请求路径Path的操作,具有很好的参考价值,希望对大家有所帮助。如有错误或未考虑完全的地方,望不吝赐教