Swagger — это инструмент для документирования и тестирования API. Он предоставляет интерфейс для изучения конечных точек, тестирования входных и выходных данных и создания клиентских библиотек для разных языков программирования.

В этом сообщении блога мы рассмотрим, как интегрировать Swagger в проект Node.js с помощью пользовательского интерфейса Swagger и библиотек Swagger Autogen и вывести JSON.

Установка пользовательского интерфейса Swagger и Swagger Autogen
Первым шагом является установка библиотек Swagger UI и Swagger Autogen. Мы можем сделать это с помощью npm. Откройте окно терминала и перейдите в корневой каталог вашего проекта Node.js. Затем выполните следующую команду:

Swagger — это инструмент для документирования и тестирования API. Он предоставляет интерфейс для изучения конечных точек, тестирования входных и выходных данных и создания клиентских библиотек для разных языков программирования. В этом сообщении блога мы рассмотрим, как интегрировать Swagger в проект Node.js с помощью пользовательского интерфейса Swagger и библиотек Swagger Autogen и вывести JSON.

Установка пользовательского интерфейса Swagger и Swagger Autogen
Первым шагом является установка библиотек Swagger UI и Swagger Autogen. Мы можем сделать это с помощью npm. Откройте окно терминала и перейдите в корневой каталог вашего проекта Node.js. Затем выполните следующую команду:

npm install swagger-ui-express swagger-autogen

Это установит в ваш проект библиотеки Swagger UI и Swagger Autogen.

Настройка пользовательского интерфейса Swagger
После установки библиотек нам нужно настроить пользовательский интерфейс Swagger в нашем проекте Node.js. Создайте новый файл в корневом каталоге проекта с именем swagger.js. Этот файл будет содержать код установки пользовательского интерфейса Swagger.

const swaggerUi = require('swagger-ui-express');
const swaggerDocument = require('./swagger.json');

module.exports = (app) => {
  app.use('/api-docs', swaggerUi.serve, swaggerUi.setup(swaggerDocument));
};

Этот код устанавливает промежуточное ПО пользовательского интерфейса Swagger для нашего приложения Express. Промежуточное ПО swaggerUi.serve обслуживает файлы пользовательского интерфейса Swagger, а промежуточное ПО swaggerUi.setup создает новый маршрут в /api-docs, где мы можем получить доступ к пользовательскому интерфейсу Swagger.

Переменная swaggerDocument — это файл JSON, который описывает конечные точки API, входные и выходные данные и другие сведения о нашем API. Мы создадим этот файл позже в этом блоге.

Настройка Swagger Autogen
Теперь, когда мы настроили пользовательский интерфейс Swagger, нам нужно настроить Swagger Autogen. Эта библиотека автоматически генерирует документацию Swagger на основе обработчиков маршрутов нашего приложения Express.

Создайте новый файл в корневом каталоге вашего проекта с именем swagger-autogen.js. Этот файл будет содержать код установки Swagger Autogen.

const swaggerAutogen = require('swagger-autogen')();

const outputFile = './swagger.json';
const endpointsFiles = ['./routes/*.js'];

const config = {
    info: {
        title: 'Blog API Documentation',
        description: '',
    },
    tags: [ ],
    host: 'localhost:3000/api',
    schemes: ['http', 'https'],
};

swaggerAutogen(outputFile, endpointsFiles, config);

Этот код настраивает Swagger Autogen для создания документации Swagger для наших конечных точек API. Переменная outputFile — это имя файла JSON, в котором будет сохранена документация. Переменная endpointsFiles представляет собой массив путей к файлам обработчиков маршрутов нашего приложения Express.

Дайте мне знать в комментарии, если этот блог удовлетворит ваше требование чванства.

И, Ты можешь сделать мне кофе☕️

Спасибо за прочтение, Следуйте за мной для получения дополнительной информации :)