5 خطوات لإنشاء api ناجح

إنها طبيعة تطوير البرمجيات. يقوم المطورون بإنشاء البرامج مع مراعاة المستخدم النهائي. يبدو الأمر بسيطًا جدًا ، لكن في بعض الأحيان يكون هؤلاء المستخدمون أيضًا زملاء للمطورين. إنهم لا يحتاجون إلى أشياء مجزأة لهم. لا يحتاجون حتى يحتاجون إلى البساطة. كل ما يريدونه هو الوصول - طريقة لدمج برنامجك مع برامجهم. هذا هو المكان الذي تأتي فيه واجهة برمجة التطبيقات (API) (واجهة برمجة التطبيقات) ، وآمل أن أسلط الضوء على خمس خطوات يمكنك اتخاذها لإنشاء واجهة برمجة تطبيقات ناجحة.

قم بواجبك المنزلى

عندما يتعلق الأمر بتطوير البرمجيات ، لا أحد منا يريد إعادة اختراع العجلة. في هذه المرحلة ، تمتلك كل شركات الويب الكبيرة تقريبًا واجهات برمجة التطبيقات (APIs) لمنتجاتها البرمجية. ادرس واجهات برمجة التطبيقات هذه وحاول التقاط قرارات التصميم المختلفة التي تم إنشاؤها.

هناك العديد من التقنيات المختلفة هناك ، لكن معظم واجهات برمجة التطبيقات التي سترى ستستخدم إما واجهة RESTful أو SOAP. إذا كنت على الحياد فيما يتعلق بواجهة واجهة برمجة التطبيقات التي ستستخدمها ، أقترح استخدام نهج RESTful باستخدام بروتوكول HTTP. إنه أبسط من SOAP ، وهو أكثر شيوعًا في الوقت الحالي ، وسيكون من الأسهل البدء به عند استخدام منتج برنامج يستند إلى الويب.

كن متسقا

واحدة من الأشياء التي يقدرها المطورون أكثر هي الاتساق. وهذا يشمل ، من بين أمور أخرى ، قابلية العنوان ، وسيطات الإدخال ، وتنسيقات الإخراج ومعالجة الأخطاء.

عند استخدام أسلوب RESTful ، هناك العديد من أنظمة تسمية URI المختلفة. كل واحد لديه مؤيديه ، لذلك مجرد اختيار واحد والعصا معه. الشيء نفسه ينطبق على هيكل المدخلات والمخرجات. تدعم معظم واجهات برمجة التطبيقات استخدام XML و JSON كتنسيقات للإدخال والإخراج. أود أن أقترح دعم كليهما ، ولكن اختيار تنسيق افتراضي.

بالنسبة للمدخلات ، يجب تسمية متطلبات المدخلات الخاصة بك بشكل متسق ويجب أن تكون منطقية في سياق مكالمة واجهة برمجة التطبيقات التي تجريها. بالنسبة إلى الإخراج ، تأكد من أنك تستخدم تخطيطات بنية البيانات الشائعة. إذا كنت تقوم بتغليف إخراج استدعاء API واحد في علامة XML ، فكّر في القيام بذلك باستخدام مكالماتك الأخرى.

من الممارسات الشائعة تضمين نوع من علامة الحالة في بيانات المخرجات التي ترسلها إلى العميل. عند استخدام أسلوب RESTful API ، يجب القيام بذلك باستخدام رموز حالة HTTP. على سبيل المثال ، إذا عالجت للتو طلب PUT على كائن بيانات موجود ، فسوف يختلف رمز حالة HTTP الذي تضيفه في إجابتك اعتمادًا على نتيجة الطلب.

بدلاً من الإشارة التعسفية التي تشير إلى حالة المكالمة ، يمكن استخدام رمز حالة قياسي "200 OK" للإشارة إلى نجاح الطلب ، بينما يمكن استخدام رمز حالة "400 طلب سيئ" للإشارة إلى أن الطلب كان المشوهة. هناك عدد غير قليل من رموز حالة HTTP التي يمكن استخدامها في مواقف مختلفة.

استخدم OAuth

ستتضمن معظم منتجات البرامج نوعًا من مصادقة المستخدم للوصول إلى الموارد المحمية لهذا المستخدم. عندما يتعلق الأمر بواجهات برمجة التطبيقات ، فإن قيام العميل بجمع بيانات اعتماد المستخدم لإرسالها إلى الخادم الخاص بك يعد ممارسة سيئة. هذا هو المكان الذي يأتي فيه OAuth.

يوفر OAuth العديد من الفوائد على مصادقة اسم المستخدم / كلمة المرور لجهة خارجية. قبل كل شيء ، العميل ليس لديه حق الوصول إلى بيانات اعتماد المستخدم. تتم إعادة توجيه المستخدم إلى الخادم الخاص بك عندما يقوم بتسجيل الدخول. بعد تسجيل دخول المستخدم إلى موقعك ، تتم إعادة توجيهه إلى العميل حيث سيتلقى العميل رمز وصول للوصول لاستخدامه في الطلبات المستقبلية للموارد المحمية.

ميزة أخرى مهمة لاستخدام OAuth هي قدرة المستخدم على إلغاء وصول العميل في أي وقت. إذا قرر المستخدم ، لأي سبب من الأسباب ، أنهم لم يعودوا يريدون أن يتمكن العميل من الوصول إلى الموارد المحمية نيابة عنهم ، فإنهم ببساطة ينتقلون إلى واجهة قمت بإنشائها وإلغاء وصول العميل.

بدأت باكرا

أحد أهم الأشياء التي يمكنك القيام بها لجعل API ناجحًا هو البدء مبكرًا. عندما تكتب هذه الوظيفة لإنشاء بعض المدخلات في قاعدة البيانات الخاصة بك ، والمضي قدما وقضاء بعض الوقت الإضافي وكتابة واجهة API لذلك.

اكتب وثائق جيدة

لا شيء يقتل API أسرع من عدم وجود وثائق جيدة. في حين أن بعض المطورين يمكنهم استخدام واجهة برمجة تطبيقات غير موثقة بشكل جيد ومعرفة كيف من المفترض أن يعملوا ، فإن معظمهم لن يرغبون في ذلك.

يجب أن توثق كل مكالمة من واجهة برمجة التطبيقات التي لديك متوفرة وأن تصنف مكالمات واجهة برمجة التطبيقات الخاصة بك حسب نوع البيانات التي تعمل بها. جنبا إلى جنب مع توثيق نقاط النهاية ل API يدعو أنفسهم ، يجب عليك تحديد منهجي وسائط الإدخال المطلوبة والاختيارية وكذلك هياكل بيانات الإخراج. يجب أن تسرد وسيطات الإدخال قيمة افتراضية في حالة وجود واحدة ، كما تشير إلى تنسيق البيانات المتوقع مثل رقم أو سلسلة. أخيرًا ، يجب أن تحتوي كل مكالمة API على قائمة بظروف الخطأ ورموز الحالة.

لتوثيق مستنداتك ، تأكد من تضمين مثال أو مثالين لسيناريوهات المدخلات والمخرجات الشائعة لكل مكالمة API.

تطوير واجهة برمجة التطبيقات: اجعلها بسيطة

على الرغم من أن تطوير واجهة برمجة التطبيقات (API) يعد مسعى معقدًا ، إلا أن فكرة واجهة برمجة التطبيقات (API) نفسها ليست مفهوما جديدا وهناك قدر كبير من الوثائق المتاحة حول كل موضوع تطرقنا إليه هنا. فقط تأكد من استخدام الممارسات الجيدة حيث يمكنك العثور عليها وتوفير واجهة متسقة وموثقة جيدًا.