Установка
В данном разделе перечислены основные пакеты LiteMW и способы их установки.
Роутер
Для начала работы вам понадобятся только два модуля: koa и @litemw/router этого достаточно для примеров из предыдщуего шага. Более подробное описание роутера смотрите в разделе создание приложения.
npm install koa @litemw/router
yarn add koa @litemw/router
pnpm i koa @litemw/router
bun i koa @litemw/router
TIP
Опционально вы можете использовать и koa-router, @litemw/router использует его внутри и делегирует все его методы.
Мидлвейры
Модуль @litemw/middlewares содержит базовые мидлвейры для работы с параметрами URL, query-параметрами, телом запроса и файлами, также в нём содержатся пайпы (pipes) - сущности для создания конвейров обработки данных.
npm install @litemw/middlewares
yarn add @litemw/middlewares
pnpm i @litemw/middlewares
bun i koa @litemw/middlewares
Для использования миддлвейра useBody и useFiles вам понадобится библиотека koa-bodyparser
npm install koa-bodyparser
yarn add koa-bodyparser
pnpm i koa-bodyparser
bun i koa-bodyparser
Опционально для валидации вы можете использовать библиотеки zod или class-validator
npm install zod
yarn add zod
pnpm i zod
bun i zod
npm install class-validator
yarn add class-validator
pnpm i class-validator
bun i class-validator
И для дополнительных возможностей по работе с OpenAPI схемами для этих библиотек вы можете использовать zod-openapi и class-validator-jsonschema
npm install zod-openapi
yarn add zod-openapi
pnpm i zod-openapi
bun i zod-openapi
npm install class-validator-jsonschema
yarn add class-validator-jsonschema
pnpm i class-validator-jsonschema
bun i class-validator-jsonschema
OpenAPI
Модуль OpenAPI предоставляет инструменты для генерации OpenAPI схемы на основе ваших роутеров, которая в последствии может быть использована например для SwaggerUI.
npm install @litemw/openapi
yarn add @litemw/openapi
pnpm i @litemw/openapi
bun i @litemw/openapi