获取SpringBoot中所有的url和其参数

获取所有url和方法的对应关系

@Data
public class Param {

    /**
     * 字段名称
     */
    private String name;

    /**
     *
     */
    private String in;

    /**
     * 字段说明
     */
    private String description;

    /**
     * 字段是否必填
     */
    private String required;

    /**
     * 字段类型
     */
    private String type;

}

@Data
public class VelocityTemplate {

    /**
     * api 标题
     */
    private String title;

    /**
     * url 名称
     */
    private String urlName;

    /**
     * 请求方法
     */
    private String requestMethod;

    /**
     * 方法描述
     */
    private String description;

    /**
     * 参数列表
     */
    private List<Param> params;

    /**
     * 参数数量
     */
    private int paramsNum;

    /**
     * 请求体格式
     */
    private String request;

    /**
     * 返回体格式
     */
    private String response;


}

@Autowired
private RequestMappingHandlerMapping mappingHandlerMapping;

public List<?> getAllUrl() throws IOException {
        List<VelocityTemplate> urlList = new ArrayList<>();
        Map<RequestMappingInfo, HandlerMethod> map = mappingHandlerMapping.getHandlerMethods();
        for (Map.Entry<RequestMappingInfo, HandlerMethod> methodEntry : map.entrySet()) {
            VelocityTemplate velocityTemplate = new VelocityTemplate();
            RequestMappingInfo info = methodEntry.getKey();
            HandlerMethod method = methodEntry.getValue();
            PatternsRequestCondition patternsRequestCondition = info.getPatternsCondition();
            for (String url : patternsRequestCondition.getPatterns()) {
                velocityTemplate.setUrlName(url);
            }

            RequestMethodsRequestCondition methodsRequestCondition = info.getMethodsCondition();
            String type = methodsRequestCondition.toString();
            if (type.startsWith("[") && type.endsWith("]")) {
                type = type.substring(1, type.length() - 1);
                // 方法名
                velocityTemplate.setRequestMethod(type);
            }
            if (StringUtils.hasText(type)) {
                velocityTemplate.setTitle("###" + (urlList.size() + 1) + "、" + (method.hasMethodAnnotation(ApiOperation.class) ?
                        method.getMethodAnnotation(ApiOperation.class).value() : ""));
                velocityTemplate.setDescription(method.toString());
                MethodParameter[] methodParameters = method.getMethodParameters();
                List<Param> params = new ArrayList<>();
                for (MethodParameter methodParameter : methodParameters) {
                    if (ObjectUtils.isEmpty(methodParameter.getParameterAnnotations()) || methodParameter.hasParameterAnnotation(Valid.class)) {
                        ReflectionUtils.FieldCallback fieldCallback = field -> {
                            ApiModelProperty annotation = field.getAnnotation(ApiModelProperty.class);
                            Param param = new Param();
                            if (annotation != null) {
                                param.setName(annotation.name());
                                param.setDescription(annotation.value());
                            } else {
                                param.setName(field.getName());
                                param.setDescription("");
                            }
                            param.setType(field.getType().getTypeName());
                            param.setRequired("是");
                            params.add(param);
                        };
                        if (methodParameter.getParameterType().getName().equals(HttpServletRequest.class.getName()) || methodParameter.getParameterType().getName().equals(HttpServletResponse.class.getName())) {
                            continue;
                        }
                        ReflectionUtils.doWithFields(methodParameter.getParameterType(), fieldCallback,
                                field -> !field.getName().equalsIgnoreCase("serialVersionUID"));
                    } else if (methodParameter.hasParameterAnnotation(RequestParam.class)) {
                        RequestParam requestParamAnnotation =
                                methodParameter.getParameterAnnotation(RequestParam.class);
                        ApiParam apiParam = methodParameter.getParameterAnnotation(ApiParam.class);
                        Param param = new Param();
                        param.setName(requestParamAnnotation.name());
                        param.setRequired(requestParamAnnotation.required() ? "是" : "否");
                        param.setType(methodParameter.getParameterType().getTypeName());
                        param.setDescription(apiParam == null ? "" : apiParam.value());
                        params.add(param);
                    }
                }
                velocityTemplate.setParams(params);
                urlList.add(velocityTemplate);
            }
        }
        GenerateWikiApiDocument.generateFile(urlList, "Statistics");
        return urlList;
    }

public static void generateFile(List<VelocityTemplate> velocityTemplates, String controllerClass) throws IOException {
        String basePath = "C:\api\";
        FileWriter file = new FileWriter(basePath + controllerClass +"API.md", false);
        BufferedWriter bufferedWriter = new BufferedWriter(file);
        //设置velocity资源加载器
        Properties prop = new Properties();
        prop.put("file.resource.loader.class", "org.apache.velocity.runtime.resource.loader.ClasspathResourceLoader" );
        Velocity.init(prop);

        Map<String, List<VelocityTemplate>> listMap = new HashMap<>();
        listMap.put("list", velocityTemplates);
        VelocityContext context = new VelocityContext(listMap);
        String templatePath = "velocity/swagger.md.vm";
        Template tpl = Velocity.getTemplate(templatePath, "UTF-8" );
        tpl.merge(context, bufferedWriter);
        bufferedWriter.close();
        file.close();
    }

#foreach($item in $list)
${item.title}


<table>
    <tr>
        <td>URL</td>
        <td colspan="4">${item.urlName}</td>
    </tr>
    <tr>
        <td>请求方式</td>
        <td colspan="4">${item.requestMethod}</td>
    </tr>
    <tr>
        <td>方法名</td>
        <td colspan="4">${item.description}</td>
    </tr>
    <tr>
        #set($size=${item.params.size()} + 3)
        <td rowspan="$size">参数格式</td>
        <td>字段</td>
        <td>字段类型</td>
        <td>是否必填</td>
        <td>说明</td>
    </tr>
    #foreach($param in $item.params)
    <tr>
        <td>${param.name}</td>
        <td>${param.type}</td>
        <td>${param.required}</td>
        <td>${param.description}</td>
    </tr>
    #end
     <tr>
        <td>请求参数</td>
        <td colspan="3">${item.request}</td>
    </tr>
    <tr>
        <td>返回参数</td>
        <td colspan="3">${item.response}</td>
    </tr>
</table>

#end