在开发阶段显示可用的 REST 资源 [英] Display available REST resources in development stage

问题描述

我想知道是否可以将 Java EE Web 应用程序(战争部署)的可用 REST 路径作为摘要输出到页面上.当然，出于安全原因，仅在开发模式下.有什么可用的吗?

I was wondering wheather it's possible to output the available REST paths of a Java EE web app (war deplopyment) as a summary on a page. Of course, for security reasons only in development mode. Is there something available for this?

谢谢

推荐答案

这里是一个快速 + 脏的示例，它将返回扫描的 ResourceClasses 的所有路径:

Here is a quick + dirty example which will return all paths for the scanned ResourceClasses:

Path("/paths")
public class PathResource {

    @GET
    @Produces(MediaType.TEXT_PLAIN)
    public Response paths(@Context HttpServletRequest request) {
        StringBuilder out = new StringBuilder();
        String applicationPath = "/"; // the path your Application is mapped to
        @SuppressWarnings("unchecked")
        Map<String, ResteasyDeployment> deployments = (Map<String, ResteasyDeployment>) request.getServletContext().getAttribute("resteasy.deployments");
        ResteasyDeployment deployment = deployments.get(applicationPath);
        List<String> scannedResourceClasses = deployment.getScannedResourceClasses();
        try {
            for (String className : scannedResourceClasses) {
                Class<?> clazz = Class.forName(className);
                String basePath = "";
                if (clazz.isAnnotationPresent(Path.class)) {
                    basePath = clazz.getAnnotation(Path.class).value();
                }
                out.append(String.format("BasePath for Resource '%s': '%s'", className, basePath)).append('\n');
                for (Method method : clazz.getDeclaredMethods()) {
                    if (method.isAnnotationPresent(Path.class)) {
                        String path = method.getAnnotation(Path.class).value();
                        out.append(String.format("Path for Method '%s': '%s'", method.getName(), basePath + path)).append('\n');
                    }
                }
            }
        } catch(ClassNotFoundException ex) {
            throw new IllegalArgumentException(ex); 
        }
        return Response.ok(out).build();
    }
}

这篇关于在开发阶段显示可用的 REST 资源的文章就介绍到这了，希望我们推荐的答案对大家有所帮助，也希望大家多多支持IT屋！