Swagger

swagger - написання документації

Swagger - це набір інструментів для розробки, документування та взаємодії з веб-сервісами на основі їх API (інтерфейсів програмування застосунків). Основний компонент Swagger - це Swagger UI, який дозволяє генерувати автоматичну документацію для веб-сервісу на основі специфікації OpenAPI (раніше відомої як Swagger Specification). Swagger дозволяє розробникам швидко розробляти, тестувати та взаємодіяти з API, а також надає зручний спосіб для документування API та його функціоналу. Завдяки Swagger, розробники можуть легко створювати, зберігати та редагувати специфікації API, а також докладно описувати всі доступні ендпоінти, параметри запитів та відповіді сервера.

* Для зручної роботи зі Swagger ми скористаємося бібліотекою @redocly/cli

npm i -D @redocly/cli

Для роботи з документацією ми одразу можемо додати відповідні зміни у поле scripts в package.json:

// package.json
{
/* Інший код файлу */
"scripts": {
"build": "npm run build-docs",
"build-docs": "redocly bundle --ext json -o docs/swagger.json",
"preview-docs": "redocly preview-docs",
}
}

Команда preview-docs допоможе нам писати документацію з hot-reload, тобто з гарячим перезавантаженням сторінки при внесенні змін(як в nodemon). Більш детально можете прочитати про це за посиланням