ما هي أفضل الممارسات لصفحة الجذر في واجهة برمجة تطبيقات REST؟
https://stackoverflow.com/questions/2894723
-
04-10-2019 - |
italiano
english
français
española
中国
日本の
العربية
Deutsch
한국어
Português
Russianسؤال
أود أن أعرف ما إذا كان هناك بعض أفضل الممارسات حول نقطة النهاية الجذرية لخدمة الويب REST؟ أعني ، هل يجب أن تكون وثائق قصيرة حول استخدام واجهة برمجة التطبيقات نفسها؟ هل يجب أن يكون مستند XML يصف جميع الطرق المتاحة؟ هل يجب أن تعود فقط "طريقة غير معروفة"؟
المحلول
هذا السؤال كما هو غير واضح. أعتقد أن هذا يعني شيئًا يشبه الدليل الذي تخضع له جميع أساليب API. على سبيل المثال ، سيكون الدليل الجذري لـ Flickr API http://api.flickr.com/services/rest/.
للحصول على مثال على مشروع يصل إلى واجهة برمجة تطبيقات Flickr ، انظر بيثون فليكرابي
نصائح أخرى
السؤال واضح تمامًا بالنسبة لي.
أعتقد أنه يجب أن يستجيب بـ 404. إذا لم يكن هناك مورد مرتبط بمسار الجذر ، فلا يوجد شيء للعودة.
إذا شعرت أن 404 غير مفيدة ، فسيكون من المقبول أيضًا إعادة عنوان URL للوثائق.
1. يستخدم Nerddinner خدمات بيانات WCF ، وهي وسيلة رائعة لتنفيذ خدمات RESTful بشكل صحيح. السبب في أنني أشير إلى ذلك ، وليس خدمات بيانات WCF مباشرةً لأنه موقع ويب عام ويمكنك استخدامه. 2. MediaWiki ليس مثالًا رائعًا لأنهم يمررون إجراءات في URI ، لكنها خدمة مريحة من الناحية الفنية وتظهر الكثير من الأفكار المثيرة للاهتمام.
نقطة الجذر الخاصة بـ REST API هي واجهة برمجة التطبيقات المحددة لأول سقوط IE "/" لعنوان URL بعد مرسل المرسل. أنه يحتوي على جميع GET للحصول على قائمة الموارد (في الغالب GET لجميع جداول قاعدة البيانات) تحتوي هذه القائمة أيضًا على جميع العناصر وفي عنصر واحد سيكون هناك حذف و PATCH و SELF GET URL. وبالتالي جعل تنفيذ Hateos.
من المفترض أن يكون REST تصف ذاتيًا ، لذا فإن إظهار الجذر هو أن الخطأ هو التصميم السيئ في رأيي. أحب أن يحتوي الجذر على معلومات تتيح لك التنقل في بقية واجهة برمجة التطبيقات. على سبيل المثال ، قد يحتوي الجذر على رابط لقائمة من فئات المنتجات التي يمكن لمستخدم API منها تحديد فئة ثم قائمة من المنتجات وما إلى ذلك.
