Swagger屏蔽某些接口显示的操作_Java教程

Swagger屏蔽某些接口显示的操作

2021-09-15 11:05zhuwei_clark Java教程

这篇文章主要介绍了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();

									    }

									}