Pular para o conteúdo principal

Instalação

@powerduck/openapi-request inclui builds ESM e CommonJS com declarações TypeScript. Requer Node.js >= 22.12.0.

Instalação​

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");

Não são necessários pacotes @types/* adicionais.

Estrutura do pacote e exportações de subcaminhos​

A entrada padrão exporta o núcleo. Cada protocolo também tem seu próprio subcaminho:

ImportaçãoConteúdo
@powerduck/openapi-requestNúcleo: createClient, createDebugger, createManualSession, AdapterRegistry, ProtoKitError, utilitários OpenAPI e tipos.
@powerduck/openapi-request/httpHttpAdapter, SseParser, detecção de streaming e construtores HTTP de coleções e ambientes (buildCollection, buildEnvironment, resolveServerUrl).
@powerduck/openapi-request/wsWebSocketAdapter, createWsManualSession e utilitários de configuração e sessões WebSocket.
@powerduck/openapi-request/grpcGrpcProtocolAdapter, GrpcAdapter, grpcCall, createGrpcManualSession e módulos de descoberta, reflexão, descritores, catálogo, credenciais, carregamento e templates.
@powerduck/openapi-request/mcpMcpAdapter, createMcpManualSession, createMcpStdioSession e módulos de transporte, configuração, descoberta e geração MCP.
@powerduck/openapi-request/graphqlGraphQLAdapter, resolveGraphQLConfig, runGraphQL, introspecção, geração de operações e gravação das alterações.

Importar um subcaminho traz os tipos e utilitários daquele protocolo sem reexportar os adaptadores não relacionados.

Pacotes opcionais por capacidade​

gRPC e MCP têm dependências pesadas, carregadas apenas no primeiro uso. Uma instalação somente HTTP funciona sem elas. Instale-as apenas quando precisar do protocolo:

  • gRPC requer @grpc/grpc-js e @grpc/proto-loader. A reflexão do servidor também exige @grpc/proto-loader >= 0.7 para loadFileDescriptorSetFromBuffer.
  • MCP requer @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

Se faltar um pacote, o carregador gRPC lança GrpcDependencyMissingError com o comando exato de instalação. Se estiver instalado, mas com defeito, lança GrpcDependencyBrokenError.

Verificação​

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

As duas importações são resolvidas após instalar o pacote.

Próximos passos​