Swageer JS Doc не мгновенно обновляет API-документы на изменения? - PullRequest
1 голос
/ 01 мая 2019

Я использую swagger-jsdoc

У меня есть app swagger js docs, как показано ниже в моем app.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

Это показывает мне документированный API в Swagger UI. Но когда я делаю обновление в любом из файлов yaml и обновляю страницу, я не вижу обновленных изменений. Я должен остановить процесс nodemon и перезапустить процесс снова, чего я не хочу делать. Итак, дайте мне знать, как я могу это сделать?

1 Ответ

4 голосов
/ 01 мая 2019

По умолчанию, nodemon ищет файлы с расширениями .js, .mjs, .coffee, .litcoffee и .json.

Чтобы добавить другие расширения, используйте следующую команду: nodemon -e yaml

Подробнее см. В официальных документах: https://www.npmjs.com/package/nodemon

Добро пожаловать на сайт PullRequest, где вы можете задавать вопросы и получать ответы от других членов сообщества.
...