Skip to content

Установка

В данном разделе перечислены основные пакеты LiteMW и способы их установки.

Роутер

Для начала работы вам понадобятся только два модуля: koa и @litemw/router этого достаточно для примеров из предыдщуего шага. Более подробное описание роутера смотрите в разделе создание приложения.

shell
npm install koa @litemw/router
shell
yarn add koa @litemw/router
shell
pnpm i koa @litemw/router
shell
bun i koa @litemw/router

TIP

Опционально вы можете использовать и koa-router, @litemw/router использует его внутри и делегирует все его методы.

Мидлвейры

Модуль @litemw/middlewares содержит базовые мидлвейры для работы с параметрами URL, query-параметрами, телом запроса и файлами, также в нём содержатся пайпы (pipes) - сущности для создания конвейров обработки данных.

shell
npm install @litemw/middlewares
shell
yarn add @litemw/middlewares
shell
pnpm i @litemw/middlewares
shell
bun i koa @litemw/middlewares

Для использования миддлвейра useBody и useFiles вам понадобится библиотека koa-bodyparser

shell
npm install koa-bodyparser
shell
yarn add koa-bodyparser
shell
pnpm i koa-bodyparser
shell
bun i koa-bodyparser

Опционально для валидации вы можете использовать библиотеки zod или class-validator

shell
npm install zod
shell
yarn add zod
shell
pnpm i zod
shell
bun i zod
shell
npm install class-validator
shell
yarn add class-validator
shell
pnpm i class-validator
shell
bun i class-validator

И для дополнительных возможностей по работе с OpenAPI схемами для этих библиотек вы можете использовать zod-openapi и class-validator-jsonschema

shell
npm install zod-openapi
shell
yarn add zod-openapi
shell
pnpm i zod-openapi
shell
bun i zod-openapi
shell
npm install class-validator-jsonschema
shell
yarn add class-validator-jsonschema
shell
pnpm i class-validator-jsonschema
shell
bun i class-validator-jsonschema

OpenAPI

Модуль OpenAPI предоставляет инструменты для генерации OpenAPI схемы на основе ваших роутеров, которая в последствии может быть использована например для SwaggerUI.

shell
npm install @litemw/openapi
shell
yarn add @litemw/openapi
shell
pnpm i @litemw/openapi
shell
bun i @litemw/openapi