是否有只发布根URL的RESTAPI文档？

我正在尝试为我的应用程序设计一个RESTAPI，我读了很多关于最佳实践和REST应该如何工作的文章。关于REST最重要的主题之一是，资源应该通过引用链接，客户机应该只知道API的根URL

但我找不到任何真正做到这一点的API文档。我在web上读过的每个RESTAPI文档都显示了可能端点的URL的精确描述

是否有任何API文档只显示根URL并描述如何在资源中导航

关于REST最重要的主题之一是，资源应该通过引用链接，客户机应该只知道API的根URL

根URL和媒体类型，是。客户机需要知道从哪里开始，以及如何解释它得到的响应

RESTAPI的主要示例是万维网。您将浏览器指向，然后只需按照链接提交表单，直到得到所需的结果

另一个大家可能熟悉的RESTAPI是/

从更学术的角度来说，这是一个问题。这篇文章有点流行，您可以在附近找到许多示例实现

演示了一个很好的超媒体API

我在web上读过的每个RESTAPI文档都显示了可能端点的URL的精确描述

---

对,；坏例子比好例子更常见。

我们这样做，但它不是公开的。但对于大多数人来说，当他们提到REST时，他们往往指的是CRUD、JSON，而不是真正的资源发现、超媒体。我在寻找一个好的例子。甚至连代码和对象结构都没有。我只是想找一个文档示例，引导用户了解api的资源。