Aller au contenu principal

Installation

@powerduck/openapi-request fournit des versions ESM et CommonJS avec les déclarations TypeScript. Node.js >= 22.12.0 est requis.

Installation​

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

Aucun paquet @types/* supplémentaire n’est nécessaire.

Structure du paquet et sous-chemins d’export​

L’entrée par défaut exporte le noyau. Chaque protocole dispose aussi de son propre sous-chemin :

ImportContenu
@powerduck/openapi-requestNoyau : createClient, createDebugger, createManualSession, AdapterRegistry, ProtoKitError, utilitaires OpenAPI et types.
@powerduck/openapi-request/httpHttpAdapter, SseParser, détection des flux et constructeurs HTTP de collections et d’environnements (buildCollection, buildEnvironment, resolveServerUrl).
@powerduck/openapi-request/wsWebSocketAdapter, createWsManualSession et utilitaires de configuration et de session WebSocket.
@powerduck/openapi-request/grpcGrpcProtocolAdapter, GrpcAdapter, grpcCall, createGrpcManualSession et modules de découverte, réflexion, descripteurs, catalogue, identifiants, chargement et modèles.
@powerduck/openapi-request/mcpMcpAdapter, createMcpManualSession, createMcpStdioSession et modules de transport, configuration, découverte et génération MCP.
@powerduck/openapi-request/graphqlGraphQLAdapter, resolveGraphQLConfig, runGraphQL, introspection, génération d’opérations et réécriture des modifications.

Importer un sous-chemin charge les types et utilitaires du protocole concerné, sans réexporter les autres adaptateurs.

Paquets facultatifs par fonctionnalité​

gRPC et MCP ont des dépendances volumineuses, chargées à la première utilisation. Une installation limitée à HTTP fonctionne sans elles. Installez-les uniquement pour les protocoles nécessaires :

  • gRPC nécessite @grpc/grpc-js et @grpc/proto-loader. La réflexion du serveur exige aussi @grpc/proto-loader >= 0.7 pour loadFileDescriptorSetFromBuffer.
  • MCP nécessite @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

Si une dépendance manque, le chargeur gRPC lève GrpcDependencyMissingError avec la commande d’installation exacte. Si elle est présente mais défectueuse, il lève GrpcDependencyBrokenError.

Vérification​

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

Les deux imports se résolvent une fois le paquet installé.

Pour aller plus loin​