java - 如何从 Controller 访问 REST API 的所有可用路由？

Question

我正在使用 Spring Boot 创建一个 REST API，我想在用户向 /help 甚至向 /help 发出请求时返回所有可用路由的列表(作为 JSON)只需到服务器的根端点，即在我的情况下，因为我在本地工作，localhost:8080。

我知道我可以在 Spring Boot 应用程序启动时在日志中看到可用的路由，但我不确定如何从 Spring Boot Controller 访问这些路由。正如我所说，这些路由将以 JSON 形式返回，如下所示:

{

    routes: [
        "/api/users/create",
        "/api/users/list",
        ...
    ]

}

当然，最好提供额外的必需信息来向特定 URL 发出请求，例如客户端是否需要传递某些请求参数，哪些参数，以何种格式。

例如，它的形式如下:

{

    "routes" : [
        {"route": /api/users/create", "requestParams": ["name", "age", ... ]},
        ...
    ]

}

是的，我想通过这种方法，向尝试使用我创建的 REST 服务的客户提供某种文档。

我该怎么做？有没有一种至少访问路线的简单方法？

这样做会有什么问题吗？如果有，是哪些？

Answer 1

您可以使用RequestMappingHandlerMapping

注入(inject):

@Autowired
public RequestMappingHandlerMapping requestMappingHandlerMapping;

然后:

@RequestMapping("/endpoints")
public @ResponseBody
Object showEndpointsAction() throws SQLException
{
        return requestMappingHandlerMapping.getHandlerMethods().keySet().stream().map(t ->
               (t.getMethodsCondition().getMethods().size() == 0 ? "GET" : t.getMethodsCondition().getMethods().toArray()[0]) + " " +                    
               t.getPatternsCondition().getPatterns().toArray()[0]
        ).toArray();
 }

应列出所有端点 URL 路径。