Lewati ke konten utama

Instalasi

@powerduck/openapi-request menyertakan build ESM dan CommonJS beserta deklarasi TypeScript. Memerlukan Node.js >= 22.12.0.

Instalasi​

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

Tidak perlu paket @types/* tambahan.

Struktur paket dan ekspor subjalur​

Titik masuk bawaan mengekspor API inti. Setiap protokol juga memiliki subjalur sendiri:

ImporIsi
@powerduck/openapi-requestInti: createClient, createDebugger, createManualSession, AdapterRegistry, ProtoKitError, helper OpenAPI, dan tipe.
@powerduck/openapi-request/httpHttpAdapter, SseParser, deteksi streaming, serta pembuat koleksi dan lingkungan HTTP (buildCollection, buildEnvironment, resolveServerUrl).
@powerduck/openapi-request/wsWebSocketAdapter, createWsManualSession, serta helper konfigurasi dan sesi WebSocket.
@powerduck/openapi-request/grpcGrpcProtocolAdapter, GrpcAdapter, grpcCall, createGrpcManualSession, serta modul penemuan, refleksi, deskriptor, katalog, kredensial, pemuat, dan template.
@powerduck/openapi-request/mcpMcpAdapter, createMcpManualSession, createMcpStdioSession, serta modul transport, konfigurasi, penemuan, dan pembuatan MCP.
@powerduck/openapi-request/graphqlGraphQLAdapter, resolveGraphQLConfig, runGraphQL, introspeksi, pembuatan operasi, dan penulisan kembali perubahan.

Mengimpor subjalur protokol memuat tipe dan helper protokol tersebut tanpa mengekspor ulang adaptor lain.

Paket kemampuan opsional​

gRPC dan MCP memiliki dependensi besar yang dimuat saat pertama digunakan. Instalasi khusus HTTP dapat berjalan tanpanya. Instal hanya jika protokol tersebut diperlukan:

  • gRPC memerlukan @grpc/grpc-js dan @grpc/proto-loader. Refleksi server juga memerlukan @grpc/proto-loader >= 0.7 untuk loadFileDescriptorSetFromBuffer.
  • MCP memerlukan @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

Jika paket tidak tersedia, pemuat gRPC melempar GrpcDependencyMissingError dengan perintah instalasi yang tepat. Jika terinstal tetapi rusak, yang muncul adalah GrpcDependencyBrokenError.

Verifikasi​

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

Kedua impor dapat diselesaikan setelah paket diinstal.

Langkah berikutnya​