【问题标题】:Reference mongoose schema definition in swagger-jsdoc?在 swagger-jsdoc 中参考猫鼬模式定义?
【发布时间】:2021-03-20 11:15:05
【问题描述】:

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

我目前正在使用 swagger-jsdoc。

感谢和问候

[/编辑] 我了解,mongoose-to-swagger 基本上执行此任务。 但是,我不知道如何在我的 swagger-jsdoc 代码 cmets 中引用这种生成的 swagger 模式。

【问题讨论】:

    标签: express mongoose swagger


    【解决方案1】:

    我遇到了完全相同的问题,我如何解决它是我创建了一个名为 swaggerSchemas 的文件,我在其中导出了所有模式,如下例所示:

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

    User 是猫鼬模型。 最后在你招摇的 jsdoc 选项中,你需要如下内容:

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

    【讨论】:

    • 很酷,很基础也很明显!谢谢,卢卡!
    猜你喜欢
    • 2013-01-25
    • 2015-03-16
    • 2017-09-13
    • 2022-01-08
    • 2018-06-20
    • 1970-01-01
    • 2018-01-21
    • 2015-02-23
    • 2015-01-14
    相关资源
    最近更新 更多