使用 SwaggerJS 创建 API 工厂

Creating API factory with SwaggerJS

本文关键字：工厂 API 创建 SwaggerJS 使用      更新时间：2023-09-26

所以我有一个长期存在的APIService工厂，它创建函数以通过招摇的函数传递到UI。以下是工厂的片段：

'use strict';
angular.module('myApp').factory('APIService', function ($http, $window, $q, swaggerClient, $mdToast) {
    var ApiDoc = {};
    ApiDoc.getAllBookmarks = function () {
        return $q(function (resolve, reject) {
            $http.get('client/components/api/Schema.json')
                    .success(function (data) {
                        var schema = data;
                        _.each(schema.apis, function (b) {
                            b.apiDeclaration.basePath = $window.location.origin;
                        })
                        var api = swaggerClient(schema);
                        api = api.apiBookmarks.getAll();
                        resolve(api);
                     });
        });
    }
    return ApiDoc;
});

以下是它在控制器中的用例片段：

$scope.getAllDashboards = function () {
    APIService.getAllBookmarks().then(function(data){
        if (data.length > 0){
           $scope.dashboardsList = data;
           $scope.emptyDash = false;
        } else {
           $scope.emptyDash = true;
        }
    })
}
$scope.getAllDashboards();

这里固有的问题是，如果我在一个控制器中有 30 个 API 函数调用，那么实际上有 30 个 $http 个 schema.json 请求是不需要的。问题是我无法弄清楚如何请求/存储该 json 并以与现在相同的方式大摇大摆地调用函数（否则我必须更改控制器中的 200+ 方法，呃）。我试过这个：

// var api = null;
// $http.get('client/components/api/Schema.json')
//     .success(function (data) {
//         var schema = data;
//         _.each(schema.apis, function (b) {
//             b.apiDeclaration.basePath = $window.location.origin;
//         })
//         api = swaggerClient(schema);
//     });

但是在那之后无法让函数正确读取它，或者像控制器期望的那样以承诺返回函数调用的结果。

我这里没有其他JS开发人员，所以我需要你们所有人的帮助！多谢！

这很丑陋。如果您将 swagger-client 升级到更现代的东西，您有一些选择。

首先，您可以将模式缓存为对象，并使用参数 spec 在 swaggerClient 构造函数中提供它。 构造目标主机时，仍需要将目标主机的 URL 传递给客户端。 这样，就不需要远程调用任何东西。

接下来，您可以了解如何保留适当的 swaggerClient 实例，并在每次调用中使用它。

相关文章：