javascript - 如何使用 swagger-ui 模块在我的 MEAN 堆栈项目中显示 Swagger JSON 文件？

Question

我是 NodeJS 和 AngularJS 的新手，所以我可能会完全错误地处理这个问题，但值得一问......

我正在尝试使用 swagger-ui Node module 以具有交互性的 Swagger 风格显示我的 API 文档。

我想通过传入我自己的 Swagger JSON 文件(托管在 public/assets/my-swagger.json 中)来在 NodeJS 应用程序中执行此操作。

我假设我可以做这样的事情:

angular.module('SwaggerCtrl', []).controller('SwaggerController', function($scope) {

    $scope.swagger = new function() {
        var swaggerUi = new SwaggerUi({
            url: '../../assets/my-swagger.json',
            dom_id: "swagger-ui-container"
        });

        swaggerUi.load();
    };

});

取自 https://www.npmjs.com/package/swagger-ui#swaggerui 。

然后在我的 swagger.html 中我会做这样的事情:

<div class="jumbotron text-center">
    <h1>Swagger</h1>

    <p>{{ swagger }}</p>

    <div id="swagger-ui-container"></div>
</div>

但是，当我转到 http://localhost:8080/swagger 时，我在控制台上收到 ReferenceError: SwaggerUi is not Define 错误消息。

我正在尝试弄清楚如何调用 swaggerUi.load() 以便在用户转到 http://localhost:8080/swagger 时加载 my-swagger.json 文件.

我还查看了 https://www.npmjs.com/package/swagger-ui-middleware，但它正在加载 node_modules/swagger-ui/dist 目录中找到的默认 Petstore API。

Answer 1

我对此也是新手，并且使用了这两个模块:swagger-jsdoc(它根据 node.js 文件中的注释生成 swagger.json 和 swagger-ui-express 来显示信息。

稍后查看文档，您可能会找到问题的答案。