有没有办法发现一个ReST API的所有端点？ [英] Is there a way to discover all endpoints of a ReST API?

问题描述

我想知道是否可以通过编程方式发现特定API的所有端点。

I'm wondering if its possible to programmatically discover all the endpoints of a particular API.

例如，如果我使用浏览器或curl获取此网址：
https://api.twitter.com/1.1/

So for example if I GET this URL with a browser or curl: https://api.twitter.com/1.1/

我可能会得到类似这样的JSON响应： / p>

I might get something like this as a JSON response:

{"TwitterAPI":{
    "version" : 1.1,
    "GET" : {
        "search/" : ["users", "trending"],
        "users/" : ["id", "handle"]
    }
}

当然，Twitter可以选择发布或不发布此格式。所以作为一个侧面的问题，是否有任何Java或JavaScript的库，将自动映射和发布您在控制器中创建的API路由？

Of course Twitter could choose to publish or not publish this format. So as a side question, are there any libraries for Java or Javascript that will automatically map and publish the API routes you created in your controllers?

推荐答案

没有办法以编程方式发现REST服务，因为
没有一个标准的注册表服务。

There is no way of programmatically discovering REST services as they do not have a standard registry service.

除了做一些疯狂的暴力搜索，没有办法找到正确的网址正确的参数）。因此，唯一的选择是记录您的API。为此，我目前看到的最佳选择是：

Apart from doing something insane brute-force search there is no way of finding the right URLs ( not to mention the right parameters). So the only option is documenting your API. For that the best choice I have seen so far is:

• Swagger


• 其他人也喜欢 API蓝图。

• Swagger
• And people also like API Blueprint.

这篇关于有没有办法发现一个ReST API的所有端点？的文章就介绍到这了，希望我们推荐的答案对大家有所帮助，也希望大家多多支持IT屋！