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

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设计 - 第二版

您还可以通过访问http://bit.ly/M28lOu获得免费的书籍Web API设计 - 开发者喜爱的制作界面以及上述视频

关于包装器,可能值得考虑以下事项:

1. 使您的包装一致.

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

2. 包装还是抽象？就是那个问题.

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

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