Question

我正在寻找在轻量级JavaScript客户端中包装REST API的最佳实践样式。

过去我见过以类似的方式实现的库：

var request = new SearchRequest(apikey);
request.query = "search term";
request.send(function(results) {
    console.log(results);
});

或更明确地接受HTTP，如：

api.get("search", "search term", function(results) {
    console.log(results);
});
api.post("comment", comment, function(results) {
    console.log(results);
});

或者包裹在更高的层次：

api.search("search term", function(results) {
    console.log(results);
});
api.createComment(comment, function(results) {
    console.log(results);
});

最近您看到了包装REST API的现代JavaScript客户端库的哪些好例子。不担心实现细节，只是API设计。

谢谢！

Answer 1

我观看了一个关于良好API设计的非常好的视频。绝对值得观看。

RESTful API Design - Second Edition

您还可以通过转到http://bit.ly/M28lOu

获取免费的书籍 Web API设计 - 开发人员喜爱的制作界面以及上述视频

关于包装器，可能值得考虑以下事项：

让您的包装器保持一致。

采用您正在使用的编程语言或社区的标准，命名约定等，使包装对使用它的人感觉尽可能自然。

包装还是抽象？这是个问题。

通过 Wrapping ，您可以尽可能地模仿REST API方法和结构，但只需简化一些难点。这种方法的一大优势是，它可以在目标REST API升级时更容易升级。

抽象在目标REST API复杂或以非标准方式运行和查看时非常有用。在这种情况下，您的包装器方法和调用可能根本不像您的目标REST API方法，但最终会简化那些使用您的包装器的人的生活（希望如此）。

Answer 2

检查这些：

Restangular（需要有角度的）
Resful.js（如Restangular，但没有角度）
cujojs/rest

StackOverflow还有其他类似的讨论，例如JavaScript REST client Library

JavaScript中的REST API客户端库有哪些好的示例

2 个答案: