首页
学习
活动
专区
圈层
工具
发布
社区首页 >问答首页 >是否有REST API文档只发布根URL?

问是否有REST API文档只发布根URL?
EN

Stack Overflow用户
提问于 2020-07-01 02:14:40
回答 1查看 28关注 0票数 0

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

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

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

EN

回答 1

Stack Overflow用户

发布于 2020-07-01 13:06:36

关于REST最重要的主题之一是,资源应该通过引用进行链接,并且客户端应该只知道

的根URL。

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

你的REST API的主要例子是万维网。您将浏览器指向www.google.com,然后只需跟踪链接并提交表单,直到获得您想要的结果。

另一个熟悉的REST API是Atom Syndication / Atom Pub.

在学术上,还有RESTBucks。这篇文章颇受欢迎,您可以在其周围找到许多示例实现。

Jon Moore (2011)展示了一个很好的超媒体应用编程接口。

我在web上读到的每个REST API文档都显示了对可能端点的URL的准确描述。

是的,坏的例子比好的例子更常见。

票数 1
EN
页面原文内容由Stack Overflow提供。腾讯云小微IT领域专用引擎提供翻译支持
原文链接:

https://stackoverflow.com/questions/62663730

复制
相关文章

相似问题

领券
问题归档专栏文章快讯文章归档关键词归档开发者手册归档开发者手册 Section 归档