关于如何获取项目中所有API路径问题

白马是马也

于 2024-04-18 10:29:37 发布

阅读量116

点赞数 2

文章标签： java

本文链接：https://blog.csdn.net/wule_le/article/details/137911038

版权

@Autowired
WebApplicationContext applicationContext;

private final RequestMappingHandlerMapping requestMappingHandlerMapping;

public TestController(RequestMappingHandlerMapping requestMappingHandlerMapping) {
    this.requestMappingHandlerMapping = requestMappingHandlerMapping;
}

/**
 * 获取项目所有api信息
 */
@GetMapping("/getParam")
public void getParam(){

    RequestMappingHandlerMapping mapping = applicationContext.getBean(RequestMappingHandlerMapping.class);
    // 拿到Handler适配器中的全部方法
    // 这是第一种，没有获取api注释
    Map<RequestMappingInfo, HandlerMethod> methodMap = mapping.getHandlerMethods();
    Set<String> urlList = new HashSet<>();
    for (RequestMappingInfo info : methodMap.keySet()){

        Set<String> urlSet = info.getPatternsCondition().getPatterns();
        // 请求方式
        Set<RequestMethod> Methods = info.getMethodsCondition().getMethods();
        // 加上自己的域名和端口号，就可以直接用
        urlList.addAll(urlSet);
    }
    for (String url : urlList) {
        // 后端代码中所有api的url
        System.out.println("https://vip.xxxx.com/" + url);
    }
	// 这是第二种，获取api注释
    Map<RequestMappingInfo, HandlerMethod> map = requestMappingHandlerMapping.getHandlerMethods();
    for (Map.Entry<RequestMappingInfo, HandlerMethod> entry : map.entrySet()) {
        HandlerMethod method = entry.getValue();
        Set<String> uriPatterns = entry.getKey().getPatternsCondition().getPatterns();
        Set<RequestMethod> methodPatterns = entry.getKey().getMethodsCondition().getMethods();
        if(CollectionUtil.isEmpty(uriPatterns) || CollectionUtil.isEmpty(methodPatterns)){
            continue;
        }
        String methodPattern =  new ArrayList<String>(uriPatterns).get(0);
        String methodTypePattern =  new ArrayList<RequestMethod>(methodPatterns).get(0).name();
        Annotation[] annotations = method.getMethod().getDeclaredAnnotations();
        if (annotations == null) {
            continue;
        }
        for (Annotation annotation : annotations) {
            //获取所有用了ApiOperation注解的方法类
            if (annotation instanceof ApiOperation) {
                ApiOperation methodDesc = (ApiOperation) annotation;

                //方法描述
                String methodDescName = methodDesc.value();
                //方法名
                String methodName = method.getMethod().getName();
                //类全名
                String classAllName = method.getBeanType().getName();
                // @ApiOperation 中value名称
                System.out.println(methodDescName +"|"+ "https://vip.xxxx.com/" +methodPattern );
            }
        }
    }
}