返回顶部
首页 > 资讯 > 后端开发 > Python >Swagger屏蔽某些接口显示的操作
  • 426
分享到

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

2024-04-02 19:04:59 426人浏览 泡泡鱼

Python 官方文档:入门教程 => 点击学习

摘要

swagger屏蔽某些接口显示 首先说下为什么要屏蔽,因为某些接口是针对内部服务调用的,不需要进行对接。显示出来的话: 1、容易混淆 2、容易暴露相关接口内容 其实屏蔽的话比较简单,

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

以上为个人经验,希望能给大家一个参考,也希望大家多多支持编程网。

--结束END--

本文标题: Swagger屏蔽某些接口显示的操作

本文链接: https://lsjlt.com/news/129154.html(转载时请注明来源链接)

有问题或投稿请发送至: 邮箱/279061341@qq.com    QQ/279061341

猜你喜欢
软考高级职称资格查询
编程网,编程工程师的家园,是目前国内优秀的开源技术社区之一,形成了由开源软件库、代码分享、资讯、协作翻译、讨论区和博客等几大频道内容,为IT开发者提供了一个发现、使用、并交流开源技术的平台。
  • 官方手机版

  • 微信公众号

  • 商务合作