在swagger-jsdoc中引用mongoose模式定义？

Question

4

我用mongoose建立了一个带有mongoDB后端的express.js项目。由于我是通过mongoose schemas创建mongoose模型的，所以我想知道是否可以引用mongoose schema定义而不是重新输入所有内容。

我目前正在使用swagger-jsdoc。

谢谢和最好的问候

[编辑] 我明白mongoose-to-swagger基本上执行此任务。然而，我不知道如何在我的swagger-jsdoc代码注释中引用这样生成的swagger schema。

- user2495085

2个回答

0

除了当前的答案之外，你可以这样引用模式：

$ref: '#/components/schemas/user

- Tom Strong

网页内容由stack overflow 提供, 点击上面的

可以查看英文原文，
原文链接

- Luka Mikavica · Accepted Answer

我曾经遇到过完全相同的问题，解决方法是创建了一个名为 swaggerSchemas 的文件，然后在其中导出所有模式，就像以下示例中所示：

export default {
  user: m2s(User),
};

在这里，User 是 mongoose 模型。最后，在你的 swagger jsdoc 选项中，你需要像下面这样写：

const options = {
      definition: {
       ...
        components: {
          schemas: swaggerSchemas,
        },
       ...
      },
      ...
};