Как правильно подключить Swagger для fastify на node.js?

Question

[vaflya]

Добрый день, подскажите пожалуйста: пытаюсь подключит swagger для Rest API на fastify, но ничего не получается:

index.ts

import * as SwaggerPlugin from 'fastify-swagger'

const server = fastify ({
        logger: true
})

// Документация API
server.register( SwaggerPlugin, require('./config/swagger'))

server.listen (Number.parseInt(process.env.PORT) || 3000, '0.0.0.0', (err, address) => {
       if (err) throw err

       server.log.info(`Server listening on ${address}`)
       server.swagger()
})

swagger.ts

exports.options = {
    routePrefix: '/doc',
    exposeRoute: true,
    swagger: {
      info: {
        title: 'Fastify API',
        description: 'Building a blazing fast REST API with Node.js, MongoDB, Fastify and Swagger',
        version: '1.0.0'
      },
      externalDocs: {
        url: 'https://swagger.io',
        description: 'Find more info here'
      },
      host: 'localhost:3000',
      schemes: ['http'],
      consumes: ['application/json'],
      produces: ['application/json']
  }
}

Вывожу в консоль server.swagger() Он отображает правильно все собранные роуты
Вывожу в консоль fastify.printRoutes() В нем не содержится роут на страницу swagger с документацией API

Сутки уже ничего не получается, посмотрел все примеры на github, ничего дополнительно не нужно. localhost:3000/doc возвращает 404

Answer 1

[Евгений]

У меня всё работает с таким же кодом

const fastify = require('fastify');
const SwaggerPlugin = require('fastify-swagger');

const server = fastify({
  logger: true
});

server.register(SwaggerPlugin, {
  routePrefix: '/doc',
  exposeRoute: true,
  swagger: {
    info: {
      title: 'Fastify API',
      description: 'Building a blazing fast REST API with Node.js, MongoDB, Fastify and Swagger',
      version: '1.0.0'
    },
    externalDocs: {
      url: 'https://swagger.io',
      description: 'Find more info here'
    },
    host: 'localhost:3000',
    schemes: ['http'],
    consumes: ['application/json'],
    produces: ['application/json']
  }
});

server.listen(Number.parseInt(process.env.PORT) || 3000, '0.0.0.0', (err, address) => {
  if (err) throw err;

  server.log.info(`Server listening on ${address}`);
  server.swagger()
});

Comments

[vaflya]

Евгений, вот в этом и вопрос)))). Не могли бы распечатать fatify.routes()?)))

Просто предполагаю где, но не уверен.

[Евгений]

vaflya,

evgenij@Air-Evgenij toster % node fastify.test.js 
└── /
    └── doc (GET)
        └── / (GET)
            ├── json (GET)
            ├── yaml (GET)
            ├── static/
            │   └── * (GET)
            └── * (GET)

добавил внутрь listen

server.ready(() => {
    console.log(server.printRoutes());
  });

[vaflya]

Евгений, странно, но у меня он не добавляется в список роутов. Евгений, спасибо за уделенное время!

[vaflya]

Евгений, суть была в импортируем файле настроек для Swagger

подставил настройки напрямую

server.register( SwaggerPlugin, {
        routePrefix: '/doc',
        exposeRoute: true,
        swagger: {
          info: {
            title: 'Fastify API',
            description: 'Building a blazing fast REST API with Node.js, MongoDB, Fastify and Swagger',
            version: '1.0.0'
          },
          externalDocs: {
            url: 'https://swagger.io',
            description: 'Find more info here'
          },
          host: 'localhost:3000',
          schemes: ['http'],
          consumes: ['application/json'],
          produces: ['application/json']
        }
    })

все работает

[Евгений]

vaflya, а ну логично
require('./config/swagger').options

[vaflya]

Евгений, оу спасибо!

Answer 2

[vaflya]

Суть была в импортируемом файле настроек для Swagger

подставил настройки напрямую

server.register( SwaggerPlugin, {
        routePrefix: '/doc',
        exposeRoute: true,
        swagger: {
          info: {
            title: 'Fastify API',
            description: 'Building a blazing fast REST API with Node.js, MongoDB, Fastify and Swagger',
            version: '1.0.0'
          },
          externalDocs: {
            url: 'https://swagger.io',
            description: 'Find more info here'
          },
          host: 'localhost:3000',
          schemes: ['http'],
          consumes: ['application/json'],
          produces: ['application/json']
        }
    })

все работает

p.s:
Swagger должен быть подключен до определения роутов или подключения плагинов с роутами