التثبيت
تتضمن @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/http | HttpAdapter وSseParser ودوال اكتشاف البث وأدوات إنشاء مجموعات HTTP والبيئات (buildCollection وbuildEnvironment وresolveServerUrl). |
@powerduck/openapi-request/ws | WebSocketAdapter وcreateWsManualSession وأدوات إعداد WebSocket وجلساته. |
@powerduck/openapi-request/grpc | GrpcProtocolAdapter وGrpcAdapter وgrpcCall وcreateGrpcManualSession ووحدات الاكتشاف والانعكاس والواصفات والفهرس وبيانات الاعتماد والتحميل والقوالب. |
@powerduck/openapi-request/mcp | McpAdapter وcreateMcpManualSession وcreateMcpStdioSession ووحدات نقل MCP وإعداده واكتشافه وتوليده. |
@powerduck/openapi-request/graphql | GraphQLAdapter و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";
يعمل الاستيرادان بعد تثبيت الحزمة.