Question

我在app.js中设置了如下所示的js激进文档

//include swagger js doc
var swaggerJSDoc = require('swagger-jsdoc');
const swaggerUi = require('swagger-ui-express');
const pathToSwaggerUi = require('swagger-ui-dist').absolutePath()



const swaggerDefinition = {
    swagger: '2.0',
    info: {
        // API informations (required)
        title: 'API', // Title (required)
        version: '1.0.0', // Version (required)
        description: 'Used for  api documentation', // Description (optional)
    },
    host: `localhost:3000`, // Host (optional)
    basePath: '/app/v1', // Base path (optional)
};


// Options for the swagger docs
const options = {
    // Import swaggerDefinitions
    swaggerDefinition,
    // Path to the API docs
    // Note that this path is relative to the current directory from which the Node.js is ran, not the application itself.
    apis: ['./app/v1/docs/*.yaml']
};

// Initialize swagger-jsdoc -> returns validated swagger spec in json format
const swaggerSpec = swaggerJSDoc(options);

app.use('/v1/docs', swaggerUi.serve, swaggerUi.setup(swaggerSpec));

我有一些yaml文件，这些文件是我为编写api而编写的。我从浏览器中点击了网址

localhost:3000/v1/docs

这显示了我在swagger ui中记录的api。但是，当我在任何Yaml文件中进行更新并刷新页面时，我看不到更新的更改。我必须停止nodemon进程，然后重新启动我不想执行的进程。那么，让我知道我该怎么做？

Answer 1

默认情况下，nodemon查找扩展名为.js，.mjs，.coffee，.litcoffee和.json的文件。

要添加其他扩展名，请使用以下命令： nodemon -e yaml

有关更多详细信息，请参阅官方文档：https://www.npmjs.com/package/nodemon

Swageer JS文档不会即时更新更改后的api文档吗？

1 个答案: