有没有办法找到RestAPI支持的所有操作和操作所需的参数？

Question

假设我创建了一个Rest Service http://SomeServer/api/todo，并安装在服务器上。现在有没有办法让客户端通过URL找出这个Rest API提供的所有操作/功能？

例如如果你使用get方法点击下面的URL，它将返回todo项目1的详细信息 http://SomeServer/api/todo/1

Answer 1

这正是Swagger为您提供的。它还有一个UI，您可以轻松连接到REST应用程序。

看看：

https://swagger.io/

Answer 2

您可能想要使用hateoas。它用简单的话来说就像html。浏览html页面时，您可以使用链接导航到其他页面。类似的方式，使用hateoas，您的API响应会链接到其他相关的API。

示例：

假设您有一个获取用户API - http://serverAddr/user/1
假设响应是用户详细信息。使用hateoas，您将获得一个包含密钥的列表_links，其中包含其他相关网址http://serverAddr/delete/user/1