如何编写JavaScript API？

Question

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

我无法在线找到任何解释创建自己的JavaScript API的过程的资源.

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

如何编写自己的JavaScript API？

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

我实际上将在2个不同的应用程序上执行此操作.一个是在带有Tomcat,MySQL和Java的apache服务器上.另一个是关于MySQL和PHP的apache.前端全部用javascript编写,通过它与后端连接.我已经开始编写他们将用来与我们的函数进行交互的库.

Answer 1

这是一个非常通用/广泛的问题,因此只会获得非常通用/广泛的回答.如果不知道您正在使用哪种服务器端技术,目前如何构建,完成了多少工作以及需要完成多少工作(与采取一种方法需要多少工作量相关),很难提出任何建议另一个)等

我个人并不熟悉GData或YouTube API,因此我不了解他们的技术.但是,我可以提出以下个人建议:

1)我建议你避免直接对你的页面进行HTML检查,而是建议使用服务器端API来补充你的客户端API.具体来说,我会考虑一种类似RESTful的方法,您可以将实体/数据视为您希望对其执行操作的资源.

这种方法的好处是独立于您页面的实际视图/ HTML表示,因此对更改更具弹性.如果您直接针对HTML编写API,则每次更改页面时(即使内容/数据保持不变),您都有可能违反API.

拥有服务器端组件的另一个好处是,您将能够利用JSONP,这可以减轻制作跨域请求所涉及的一些麻烦.然而,JSONP的一个缺点是你不能发出POST请求,只能使用RESTful方法完成JET请求(但我仍然认为RESTful架构提供了许多好处).

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

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

4)至于实际编写JavaScript API,我建议您阅读有关JavaScript书籍的 SO的一些主题.这可能包括有关命名空间的讨论以及对组织API有用的其他主题.

正如我所说 - 这些是非常通用的建议.可能是你的用例可以通过快速而脏的HTML抓取来做得很好(尽管你可能需要使用IFrame来解决跨域限制).我上面提到的,作为一个整体,并不是一项微不足道的任务,特别是如果这些元素现在都没有到位的话.