springboot+jersey+swagger中遇到的问题

  环境:

springboot:2.0.6  jersey:2.26  swagger:1.5.9

 

jersey加载swagger配置,直接在jerseyConfig中加入如下代码

    @PostConstruct
    public void init() {
        this.configureSwagger();
    }

    private void configureSwagger() {
        this.register(ApiListingResource.class);
        this.register(SwaggerSerializers.class);
        this.register(AcceptHeaderApiListingResource.class);

        BeanConfig config = new BeanConfig();
        config.setTitle("Title");
        config.setVersion("v1");
        config.setContact("");
        config.setSchemes(new String[] { "http", "https" });
        config.setBasePath("jersey path");
        config.setResourcePackage("com.your.swagger.package");
        config.setPrettyPrint(true);
        config.setScan(true);
    }

 

    问题1:swagger生成api时会把类中所有的方法都暴露出来,但有的方法我是不想显露的,Spring版本中有ApiIgnore这个

注解可以使用,但是jersey版本中并没有提供。没办法,查看config还提供了哪个方法,发现有setFilterClass,看名字就是我想要的东西,直接在刚才的jerseyConfig中加上这个配置:

config.setFilterClass("YourFilter");//实现SwaggerSpecFilter

    在你的filter中可以实现你自己想要的过滤逻辑。代码如下:

public class YourFilter implements SwaggerSpecFilter {
    @Override
    public boolean isOperationAllowed(Operation operation, ApiDescription apiDescription, Map<String, List<String>> map, Map<String, String> map1, Map<String, List<String>> map2) {
        //do whatever you want
    }

    @Override
    public boolean isParamAllowed(Parameter parameter, Operation operation, ApiDescription apiDescription, Map<String, List<String>> map, Map<String, String> map1, Map<String, List<String>> map2) {
        return true;
    }

    @Override
    public boolean isPropertyAllowed(Model model, Property property, String s, Map<String, List<String>> map, Map<String, String> map1, Map<String, List<String>> map2) {
        return true;
    }
}

 

    问题2:有多个API的时候,想给API排序。网上给的方法都是在前台加个逻辑,但是和我的前台代码不一致,而且我下载的JS文件都是min.js那种的,就是整个JS文件是一行,也懒得再去找对应的JS,所以直接在后台debug跟踪代码,看看有什么办法来加入我自己想要的逻辑。发现在swagger在扫描完之后会执行一个ReaderListener,在这个事件中可以加入自己的各种逻辑。就是喜欢这种简单粗暴的!代码如下:

public class YourController implements ReaderListener{
    @Override
    public void afterScan(Reader reader, Swagger swagger) {
        //do whatever you want
    }
}

 

  • 1
    点赞
  • 2
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值