Шаблон для ведения документации API сервисов

Данный шаблон содержит все необходимые настройки, с помощью которых можно автоматизировать процесс создания документации по спецификации OpenAPI 3.0.

В шаблоне представлена модель для описания API сервисов, которые используют паттерн проектирования Controller Service Repository.

Установка

Для начала, нужно локально клонировать данный репозиторий:

  gh repo clone DanSoW/express-swagger-template

Затем установить все необходимые зависимости:

  npm i

Для запуска шаблона необходимо ввести следующую команду:

  npm run dev

Или, если используется Makefile:

  make run

Теперь по адресу http://localhost:5000/docs будет находится сгенерированная документация.

Name		Name	Last commit message	Last commit date
Latest commit History 5 Commits
config		config
controllers		controllers
docs		docs
dtos		dtos
exceptions		exceptions
logger		logger
logs		logs
.gitattributes		.gitattributes
.gitignore		.gitignore
Makefile		Makefile
README.md		README.md
generate-doc.js		generate-doc.js
index.js		index.js
package-lock.json		package-lock.json
package.json		package.json
wipe-dependencies.js		wipe-dependencies.js