كيفية استخدام منشئ معاملات استعلام API
- أدخل عنوان URL لنقطة النهاية.
- أضف المعاملات؛ استخدم «a, b» أو ["a","b"] للقوائم ومفاتيح الأقواس للمرشّحات المتداخلة.
- اختر نمط المصفوفات والترميز اللذين تتوقعهما الواجهة الخلفية لديك.
- انسخ عنوان URL النهائي أو سلسلة الاستعلام فقط.
مزايا منشئ معاملات استعلام API
- محرّر مفتاح/قيمة يدعم القوائم المفصولة بفواصل وقيم JSON للمصفوفات والمرشّحات المتداخلة
- مفاتيح الأقواس (filter[price][max]) وكائنات JSON تنتج بنى متداخلة
- أربعة أنماط للمصفوفات (التكرار والأقواس والفهارس والفاصلة) وترميز RFC 3986 أو ترميز النماذج
- ترتيب اختياري للمفاتيح، وتخطي القيم الفارغة، والدمج مع الاستعلام الموجود في عنوان URL الأساسي
- عنوان URL نهائي حي، وسلسلة استعلام مجرّدة، وجدول للمعاملات المرمّزة، وعرض JSON
- تحذيرات عند تجاوز عنوان URL للطول المسموح أو وجود مسافات في المفاتيح
مثال على منشئ معاملات استعلام API
التصفح والترتيب ومرشّح قائمة
الإدخال:
Base: https://api.example.com/v1/products · page=2 · per_page=25 · sort=-created_at · status=active, pending · q=café & crèmeالنتيجة:
https://api.example.com/v1/products?page=2&per_page=25&sort=-created_at&status=active&status=pending&q=caf%C3%A9%20%26%20cr%C3%A8meالأسئلة الشائعة حول منشئ معاملات استعلام API
كيف أمرّر قائمة من القيم؟
اكتبها مفصولة بفواصل (active, pending) أو كمصفوفة JSON (["a","b"]). ثم اختر نمط المصفوفات الذي تتوقعه واجهة API لديك: التكرار (status=a&status=b) أو الأقواس (status[]=a) أو الفهارس (status[0]=a) أو الفاصلة (status=a,b).
كيف أبني مرشّحات متداخلة؟
استخدم مفاتيح الأقواس مثل filter[price][max] أو كائنات JSON كقيم. تُسلسل بأقواس مرمّزة بالنسبة المئوية (filter%5Bprice%5D%5Bmax%5D=…)، وهو ما تفكّ PHP وRails وLaravel وExpress (qs) ترميزه إلى بنى متداخلة.
ما الأحرف التي تُرمَّز؟
يُرمَّز بالنسبة المئوية وفق RFC 3986 كل ما هو خارج المجموعة غير المحجوزة (الحروف والأرقام و- _ . ~)، بما في ذلك & = # + والأحرف من خارج ASCII (بايتات UTF-8). ويحوّل ترميز النماذج المسافات إضافةً إلى ذلك إلى +.
ماذا يحدث لسلسلة استعلام موجودة أصلاً في عنوان URL الأساسي؟
عند تفعيل «الاحتفاظ بالاستعلام الموجود»، تُحلَّل المعاملات الموجودة وتُدمج مع المعاملات التي تضيفها؛ وتُلحق القيم الجديدة التي تحمل المفتاح نفسه بوصفها تكرارات.