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

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

Возможно, вы ищете npmjs.com/package/swagger-node-express

Helen 06.07.2018 13:57
Стоит ли изучать PHP в 2026-2027 годах?
Стоит ли изучать PHP в 2026-2027 годах?
Привет всем, сегодня я хочу высказать свои соображения по поводу вопроса, который я уже много раз получал в своем сообществе: "Стоит ли изучать PHP в...
Поведение ключевого слова "this" в стрелочной функции в сравнении с нормальной функцией
Поведение ключевого слова "this" в стрелочной функции в сравнении с нормальной функцией
В JavaScript одним из самых запутанных понятий является поведение ключевого слова "this" в стрелочной и обычной функциях.
Приемы CSS-макетирования - floats и Flexbox
Приемы CSS-макетирования - floats и Flexbox
Здравствуйте, друзья-студенты! Готовы совершенствовать свои навыки веб-дизайна? Сегодня в нашем путешествии мы рассмотрим приемы CSS-верстки - в...
Тестирование функциональных ngrx-эффектов в Angular 16 с помощью Jest
В системе управления состояниями ngrx, совместимой с Angular 16, появились функциональные эффекты. Это здорово и делает код определенно легче для...
Концепция локализации и ее применение в приложениях React ⚡️
Концепция локализации и ее применение в приложениях React ⚡️
Локализация - это процесс адаптации приложения к различным языкам и культурным требованиям. Это позволяет пользователям получить опыт, соответствующий...
Пользовательский скаляр GraphQL
Пользовательский скаляр GraphQL
Листовые узлы системы типов GraphQL называются скалярами. Достигнув скалярного типа, невозможно спуститься дальше по иерархии типов. Скалярный тип...
0
1
2 387
2
Перейти к ответу Данный вопрос помечен как решенный

Ответы 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

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

Я реализовал это. Но я хочу использовать интерфейс Swagger

Asad Marfani 06.07.2018 14:03
swagger project edit предоставит вам доступ к пользовательскому интерфейсу Swagger (запускает его в браузере) или это не то, что вы имеете в виду?
GreensterRox 06.07.2018 15:21
Ответ принят как подходящий

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

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

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

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

Спасибо чувак. Хотя это не решило полностью мою проблему, но подсказало мне :) Теперь все решено.

Asad Marfani 09.07.2018 11:54

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

Harshal Y. 09.07.2018 11:57

Да уж, приятель!

Asad Marfani 09.07.2018 12:06

Другие вопросы по теме