Документация Swagger API в NodeJS

Question

Я столкнулся с проблемой при настройке Swagger. Как я могу реализовать Swagger для того, чтобы в моем проекте node-express написать API Doc для существующих API? Я посмотрел пакеты swagger, swagger-ui и swagger-ui-dist npm. Но не получить желаемый результат. Я хочу использовать Swagger UI, но получаю искаженную информацию в конфигурациях. Кто-нибудь может подсказать пошаговое руководство по настройке? Нужна помощь.

Answer 1

После базовой установки:

Вот пошаговое руководство.

• Добавление Swagger в существующий проект Node.js
• Использование Swagger UI с любой кодовой базой

Надеюсь, это то, что вы ищете.

Answer 2

Хорошим вариантом для начинающих является установка пакета Swagger NPM https://www.npmjs.com/package/swagger и следуйте инструкциям.

Обзор:

// install
npm install -g swagger

// create a new project
swagger project create hello-world

// edit your API using the Swagger UI
swagger project edit

Затем следуйте остальным инструкциям по кодированию ваших контроллеров.