JSON فتحتفظ بالحمولة الكاملة.
POST بجسم JSON يحتوي على query، تمامًا كما هو الحال مع أي نقطة نهاية GraphQL. يُرجع GET وDELETE الرمز 405 Method Not Allowed، إذ إن الاستعلامات عبر GET اختيارية في مواصفة GraphQL وغير مدعومة هنا.
استعلامك الأول
data في GraphQL:
طلب عدة أشياء في آن واحد
السبب الذي يدفعك إلى استخدام GraphQL هو طلب كهذا، كان سيتطلب أربعة استدعاءات REST:المصادقة
مطابقة لـ REST. أرسل مفتاح API الخاص بك كرمز bearer:profileKey تحديد الملف الشخصي بإحدى طريقتين:
- أرسل
Profile-Keyكقيمة افتراضية على مستوى الطلب بأكمله. - مرّر
profileKeyفي حقل منفرد لتجاوز تلك القيمة الافتراضية، مما يسمح لطلب واحد بالعمل على أكثر من ملف شخصي.
profileKey وقد ترفض ترويسة Profile-Key؛ على سبيل المثال، يجب أن يستخدم createProfile مفتاح API الأساسي دون تلك الترويسة. تحقّق من تعريف كل حقل في المخطط لمعرفة نطاقه، وراجع إدارة مستخدمين متعددين لمعرفة كيفية عمل مفاتيح الملفات الشخصية.
جرّبها دون كتابة أي شيفرة
GraphQL Explorer هو متصفح تفاعلي للمخطط الحالي. يسرد كل عملية GraphQL متاحة مع وسائطها وأوصافها، ويُكمل تلقائيًا أثناء الكتابة، وينفّذ الاستعلامات على حسابك. لا تحتاج إلى مفتاح API لتصفح المخطط، فالمخطط عام، تمامًا مثل هذا التوثيق. لكنك تحتاج إليه لتنفيذ استعلام، لأن كل عملية تمر عبر المصادقة نفسها المستخدمة في REST.هل تستخدم GraphQL أم REST؟
تظل REST الواجهة الأساسية، وهي التي بُني حولها معظم توثيقنا وحزم SDK والتكاملات. استخدم GraphQL عندما:- تحتاج إلى عدة أجزاء غير مترابطة من البيانات وتريدها في رحلة ذهاب وإياب واحدة.
- تريد أسماء عمليات ووسائط وكائنات إدخال وتعدادات وتحديدات استجابة ذات أنواع قابلة للقراءة آليًا. تظل معظم الاستجابات بصيغة
JSONحتى تحتفظ بغلاف REST الكامل؛ ويُرجعcreatePostحاليًاPostResultذا نوع محدد. - تستكشف واجهة API وتريد رؤية ما هو موجود دون التنقل بين صفحات التوثيق.
- ترفع ملفات. لا يمكن لبايتات الوسائط أن تنتقل عبر طلب GraphQL؛ راجع رفع الوسائط لمعرفة المسار المدعوم.
- تستخدم إحدى حزم SDK أو تكاملات بدون شيفرة الخاصة بنا، والتي تتعامل عبر REST.
- تريد أصغر قدر ممكن من التبعيات. لا يحتاج استدعاء REST إلى شيء سوى عميل HTTP.
اقرأ التالي
- استخدام واجهة API: العثور على العمليات، وأنواع الوسائط، ورفع الوسائط.
- الأخطاء: حالات الفشل التي تُغيّر حالة HTTP، ولماذا تُرجع العمليات الفاشلة HTTP 200 مع ذلك، وكيفية التعامل مع النجاح الجزئي.
- الحدود والفوترة: الحدود القصوى لحجم الاستعلام وكيفية احتساب الطلبات.