问题标签 [swagger-jsdocs]

我无法将 swagger-jsdoc 导入或要求到我的 node express web 应用程序。

系统信息： 操作系统：

套餐：

在我的 Web 应用程序中，我想使用 swaggerUI 为我的 API 创建文档。但是我的代码的导入语句从 json-loader 引发了以下错误。

import swaggerJsdoc from 'swagger-jsdoc';

引发以下错误：

const swaggerJsdoc = require("swagger-jsdoc");

引发以下错误

我在谷歌上做了一些挖掘，找到swagger-jsdoc-webpack-plugin了 webpack 插件并安装了这个插件，然后在我的 webpack.config.json 上添加了以下配置

虽然，它在我的情况下也不起作用。

我是 nodeJS、JS 和 webpack 的新手。因此，我有点卡在哪里寻找我的问题的解决方案。任何想法，将不胜感激。

谢谢

当我运行代码时，它显示Must use import to load ES Module:错误消息。我该如何解决这个..？

错误代码：'ERR_REQUIRE_ESM'

我正在尝试在 swagger 中配置我的 express rest api 文档以使用基本身份验证。为此，我使用 swagger-jsdoc 和 swagger-express-ui 包。这是我目前的招摇配置：

有没有办法在 Swagger 中安排 API 类别和端点？我在 Node.js 中使用swagger-jsdoc和swagger-ui模块。

谢谢！

我正在尝试在 express 和 node 中创建一个招摇的 API 文档。这是我完成的部分代码。

index.js 文件

我的 .yaml 文件

在这里，我想调用一个在端口 3016 中运行的 api。但是当我运行此脚本时，swagger 调用端口 3001，我在其中定义了 swagger 脚本，如屏幕截图所示。

你能帮我找出我哪里出错了吗？

我在一个带有 express 框架的 nodeJS 项目中工作，我正在使用 swagger-jsdoc 和 swagger-ui-express，我也在 yaml 文件中编写我的配置。我想记录我的服务，但是当我尝试显示嵌套对象时遇到了一些问题。简单地说，当我展开嵌套对象树时，我什么也看不到。请帮忙。

所以我正在开发数据传输对象文件中的组件 yaml 文件，以便我可以引用它们。

这是我到目前为止所拥有的：

的最后一个属性passwordRules是这个对象内部的一个对象。所以它是一个嵌套对象，但到目前为止我所拥有的并没有给我这个：

但老实说，我不确定如何完成这个，我假设这部分：

是正确的，但是在示例中提供的是我坚持的内容，在这种情况下，甚至上述内容可能也不正确。

这个想法是这样我最终可以在这里引用它：

所以我能够得到一个空对象，passwordRules如下所示：

但是如果我尝试像这样在对象中添加它的属性：

如果我尝试像这样放置示例，我什么也得不到：

我仍然一无所获。

我对我的 Swagger YAML 文件感到困惑，我 99% 肯定是正确的，但显然不是，但不确定问题可能出在哪里：

}

我认为这是medicationTags问题所在，但是当我删除它时，它不会呈现静止状态。

更新

我试图像这样遵循以下解决方案：

我正在使用 swaggerJs 将我的文档编写为文档字符串。以下是文档的代码。我想通过不提及整个架构及其示例来整理我的路由文件夹，因此我试图引用同一文件夹目录中存在的文件。我尝试过遵循 swagger 编辑器方法，但它返回“字符串”，如下所示

JSON文件：

它不是引用 JSON 中的示例，而是返回“字符串”，如图所示

我应该得到类似于 swagger 编辑器的响应，如下 所示

我认为这可能对应于自 2017 年以来 api 中的这个未解决问题，如果有人可以确认它给出了与提到的相同的错误

https://github.com/swagger-api/swagger-editor/issues/1409

我是新来的。我正在创建一个 express-nodejs-typescript，rest api 项目。我已经配置了 swagger 并且工作正常，请参阅下面的代码。

我想要的是使用本地 swagger.json 文件，而不是提供 apis 数组apis: ['src/apis/**/*.controller.ts', 'src/schemas/*.schema.ts'],

我该怎么做，请帮忙。