Перейти к основному содержимому

Установка

@powerduck/openapi-request содержит сборки ESM и CommonJS с декларациями TypeScript. Требуется Node.js >= 22.12.0.

Установка​

npm install @powerduck/openapi-request

Yarn:

yarn add @powerduck/openapi-request

pnpm:

pnpm add @powerduck/openapi-request

ESM / CommonJS​

// ESM
import { createClient } from "@powerduck/openapi-request";

// CommonJS
const { createClient } = require("@powerduck/openapi-request");

Дополнительные пакеты @types/* не нужны.

Структура пакета и экспорты подпутей​

Основной вход экспортирует ядро. Для каждого протокола также предусмотрен отдельный подпуть:

ИмпортСодержимое
@powerduck/openapi-requestЯдро: createClient, createDebugger, createManualSession, AdapterRegistry, ProtoKitError, вспомогательные средства OpenAPI и типы.
@powerduck/openapi-request/httpHttpAdapter, SseParser, обнаружение потоков и HTTP-построители коллекций и окружений (buildCollection, buildEnvironment, resolveServerUrl).
@powerduck/openapi-request/wsWebSocketAdapter, createWsManualSession, средства настройки и управления сессиями WebSocket.
@powerduck/openapi-request/grpcGrpcProtocolAdapter, GrpcAdapter, grpcCall, createGrpcManualSession, модули обнаружения, рефлексии, дескрипторов, каталога, учётных данных, загрузки и шаблонов.
@powerduck/openapi-request/mcpMcpAdapter, createMcpManualSession, createMcpStdioSession, модули транспорта, настройки, обнаружения и генерации MCP.
@powerduck/openapi-request/graphqlGraphQLAdapter, resolveGraphQLConfig, runGraphQL, интроспекция, генерация операций и запись изменений обратно.

Импорт подпути подключает типы и вспомогательные средства соответствующего протокола, не реэкспортируя остальные адаптеры.

Дополнительные пакеты возможностей​

У gRPC и MCP крупные зависимости. Они загружаются при первом использовании, поэтому установка только для HTTP работает без них. Добавляйте их лишь для нужных протоколов:

  • gRPC требует @grpc/grpc-js и @grpc/proto-loader. Для рефлексии сервера также нужен @grpc/proto-loader >= 0.7, предоставляющий loadFileDescriptorSetFromBuffer.
  • MCP требует @modelcontextprotocol/sdk.
# only when using the gRPC adapter
npm install @grpc/grpc-js @grpc/proto-loader

# only when using the MCP adapter
npm install @modelcontextprotocol/sdk

Если пакет отсутствует, загрузчик gRPC выбрасывает GrpcDependencyMissingError с точной командой установки. Если пакет установлен, но неисправен, возникает GrpcDependencyBrokenError.

Проверка​

import { createClient } from "@powerduck/openapi-request";
import { SseParser } from "@powerduck/openapi-request/http";

После установки оба импорта разрешаются успешно.

Следующие шаги​