环境:
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
}
}