Блог

Я хотел знать, какие предварительные условия необходимы для изучения swagger в node.js и какова роль чванства в node.js . Нужно ли мне изучать YAML для этого? Было бы полезно узнать, где я могу найти больше информации о swagger и его обучении.

Swagger — это способ документирования вашего сервиса REST. Он не привязан ни к какой серверной технологии. Swagger можно использовать для документирования служб Rest, созданных с помощью Java, Go или любого другого стека технологий.

Чтобы ответить на ваши вопросы.

1. предварительные требования, необходимые для изучения swagger в node.js ? —- Вы должны быть действительно знакомы с вашей контрактной частью вашего веб-сервиса. Это будет полезно, если вы немного знакомы с файлом Json или Yaml
2. какова роль swagger в node.js ? —- Для документирования служб Rest, созданных с помощью NodeJS (или любой другой серверной технологии, если на то пошло)
3. Нужно ли мне изучать YAML для этого? —- Не обязательно. Вы можете сделать это либо в Json, либо в Yaml (мое личное предпочтение — Json, потому что пробелы там на самом деле мало что значат)

редактор.swagger.у io есть хороший инструмент, с помощью которого вы можете проверить свою спецификацию swagger, конвертировать между форматами json и yaml и т. Д.
Взгляните сюда http://editor.swagger.io /#/ , немного поиграйте со спецификацией swagger API Uber.