如何编写 JavaScript API？ [关闭]

Posted 2023-02-27

【中文标题】如何编写 JavaScript API？ [关闭]

【英文标题】：How to write a JavaScript API? [closed]

【发布时间】：2011-08-31 07:02:28

【问题描述】：

我希望创建一个 API，以便其他网站可以从我的 Web 应用程序访问数据。

我无法在网上找到任何资源来解释创建您自己的 javascript API 的过程。

我想学习如何设置身份验证、数据传输等。

如何编写自己的 JavaScript API？

是否有任何好的教程可以解释创建 JavaScript API（如 GData API 或 YouTube API）的过程？

我实际上将在 2 个不同的应用程序上执行此操作。一个是在 Apache 服务器上，带有 Tomcat、mysql 和 Java。另一个是在 apache 上使用 MySQL 和 php。前端全部用 javascript 编写，通过它与后端交互。我已经开始编写他们将用来与我们的函数交互的库。

【问题讨论】：

您是否已经拥有 JavaScript API 将通过其进行交互的服务器端组件？还是您打算直接检查您的 html 页面？

我还没有服务器端组件，但我可以。取决于哪个更好或更容易。我可以，但我倾向于检查 HTML 页面。

好吧，我发现它很有用！

【参考方案1】：

这是一个非常通用/广泛的问题，因此只会获得非常通用/广泛的回答。如果不知道您正在使用什么服务器端技术、您当前的架构方式、已完成的工作量与必须完成的工作量相比，很难提出任何建议（与采用一种方法所需的工作量有关）另一个）等。

我个人并不熟悉 GData 或 YouTube API，因此我不知道它们的技术。不过，我可以提出以下个人建议：

1) 我建议您避免直接对您的页面进行 HTML 检查，而是建议使用服务器端 API 来补充您的客户端 API。具体来说，我会考虑RESTful like approach，您将您的实体/数据视为您希望对其采取行动的资源。

这种方法的好处是独立于页面的实际视图/HTML 表示，因此对更改更具弹性。如果您直接针对 HTML 编写 API，则任何时候更改页面（即使内容/数据保持不变），您都将面临破坏 API 的风险。

拥有服务器端组件的另一个好处是您将能够利用JSONP，它可以减轻发起跨域请求所涉及的一些痛苦。然而 JSONP 的一个缺点是您不能发出 POST 请求，只能发出 GET 请求，这与 RESTful 方法并不完全吻合（但我仍然相信 RESTful 架构提供了很多好处）。

2) 数据传输是一个简单的建议 - 毫无疑问我会选择JSON。在某些情况下，XML 可能比 JSON 更适合数据格式，但总的来说，我认为您会发现 JSON 非常适合您的需求。

3) 跨域请求的客户端身份验证可能很困难。这里的一种选择是使用 iframe 进行身份验证。另一种选择是使用 HMAC 或 OAuth。

4) 至于实际编写 JavaScript API，我建议阅读这里关于JavaScript books 的一些线程。可能包括关于命名空间和其他对组织 API 有用的主题的讨论。

正如我所说 - 这些是非常笼统的建议。可能是您的用例可以很好地使用快速而肮脏的 HTML 抓取（尽管您可能需要使用 IFrame 来解决跨域限制）。总的来说，我在上面提到的内容并非易事，尤其是在这些元素都没有到位的情况下。

【讨论】：

谢谢，这几乎是我开始所需的所有信息。我用我正在运行的技术更新了我的问题，仅供参考。

对于任何希望实施 oAuth 的人来说，这是一个很棒的页面，只需选择您的语言并实施库：oauth.net/code。如果您只是想更好地了解 oAuth：oauth.net