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

9fkzdhlc 于 2023-11-18 发布在 Go

关注(0)|答案(2)|浏览(121)

我已经使用mongoose构建了一个带有mongoDB后端的express.js项目。由于我已经通过mongoose模式创建了mongoose模型，我想知道是否可以引用mongoose模式定义，而不是重新输入所有内容。
我现在使用的是swagger-jsdoc。
感谢和最好的问候

**[/EDIT]**我明白，mongoose-to-swagger基本上执行此任务。然而，我不知道如何在swagger-jsdoc代码注解中引用这样一个生成的swagger模式。

2条答案

我有完全相同的问题，我如何解决它是我做了一个名为swaggerSchemas的文件，我导出了所有的模式，如下面的例子：

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

字符串
其中User是mongoose模型。最后，在swagger jsdoc选项中，您需要以下内容：

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

型

添加到当前答案，您可以像这样引用模式：

$ref: '#/components/schemas/user

字符串
此信息在swagger文档中，请单击https://swagger.io/docs/specification/using-ref/