كيفية بناء REST API في بيثون مع تورنادو (جزء 1)

لقد كنت مطورًا للواجهة الأمامية لفترة طويلة جدًا الآن ، وقد عملت كثيرًا مع نقاط REST API من قبل ، لكنني لم أعرف أبدًا كيفية إنشاء واحدة. في Octopus Labs ، نستخدم Python و Tornado لإنشاء نقاط نهائية ، وقررت فتح هذا الصندوق الأسود لمدة 10٪ ، ولم يكن الأمر صعبًا كما اعتقدت. قررت إنشاء برنامج تعليمي صغير للأشخاص الآخرين الذين يرغبون في الحصول على وظيفة في نفس الأمر أو مجرد أشخاص يرغبون في تعلم كيفية استخدام Tornado.

يفترض هذا البرنامج التعليمي أن يكون لديك معرفة أساسية ببيثون أو بعض تجربة جافا سكريبت الحديثة.

الإعداد الرئيسي

1. تأكد من وجود محرر نصوص لائق ، أوصي بـ VScode بسبب دعم تصحيح الأخطاء وهو مجاني.

2. قم بتنزيل Postman وتثبيته على جهازك ، إنه مجاني أيضًا. سيتم استخدام هذا للتحقق من عمل API الخاص بنا.

3. تأكد من تثبيت Python ، تحقق من خلال الكتابة

بيثون $

في المحطة ويجب أن يتم نقلك إلى وحدة بيثون.

إن لم يكن يمكنك تحميله من هنا. بالنسبة إلى هذا البرنامج التعليمي ، لا يهم إذا كان لديك الإصدار 2x أو 3x من Python. الخروج من وحدة التحكم عن طريق كتابة إنهاء ().

4. سوف تحتاج إلى الحصول على pipenv وهو ما يعادل بيثون npm. لتنزيله اكتب هذا في المحطة.

الشراب $ تثبيت pipenv

ثم يجب أن يظهر pipenv:

5. إنشاء مجلد في مكان ما يسمى todo-list-api وانتقل إليه.

6. النوع:

pipenv $ تثبيت اعصار

لتثبيت تورنادو. بمجرد الانتهاء من ذلك ، سترى Pipfile و Pipfile.lock مكافئًا لكل من package.json و package-lock.json.

خلق نقطة نهاية بسيطة

1. داخل مجلد todo-list-api ، أنشئ ملفًا يسمى app.py.

2. انسخ وألصق قطعة الشفرة هذه (سيتم شرح هذا الرمز لاحقًا):

3. ثم في التشغيل الطرفي الخاص بك:

pipenv $ تشغيل بيثون app.py

لا شيء يجب أن يحدث وهو أمر جيد.

4. انتقل الآن إلى http: // localhost: 3000 / في متصفحك ، وإذا سارت الأمور على ما يرام ، يجب أن تشاهد:

تهانينا ، لقد أنشأت نقطة نهاية.

الآن دعونا نوضح ما تفعله هذه الأسطر الـ 15 من الشفرة ، والكثير منها غير واضح.

خطوط واحد واثنين تستورد ، بطبيعة الحال.

الفئة HelloHandler (الأسطر 4-6) التي ترث RequestHandler لها وظيفة تسمى get () والتي تكتب dict (كائن في JS) إلى الصفحة كـ JSON.

وظيفة make_app (الأسطر 8-10) هي ما يتعامل مع عناوين url وإعدادات الخادم وكذلك إنشاء التطبيق.

والقسم الأخير يدير الخادم.

إذا __name__ == ‘__main__ ':

هذا الجزء من الشفرة مخصص فقط للاصطلاح ، وفي هذه الحالة ، يمكنك إخراجه وستظل نقطة النهاية جيدة. أساسا بيثون يقول هنا تشغيل هذا الرمز فقط إذا تم تشغيل app.py من المحطة. إذا قمنا بإنشاء ملف آخر يسمى app2.py وقمنا بتشغيل "python app2.py" بدلاً من ذلك ، فلن يتم تشغيل الكود أدناه إذا لم يتم تشغيل "__name__ == __main__" في app.py.

ساعي البريد الإعداد

نظرًا لأننا لن نتحقق من نقاط النهاية في المتصفح طوال الوقت فلنقم بإعداد ساعي البريد للقيام بذلك

1. انقر على أيقونة المجموعة الجديدة وأعطها اسم "قائمة Tornado todo".

2. في علامة تبويب جديدة ، إذا كان القائمة المنسدلة بجوار شريط العنوان لا تعني GET ، فعليك تغييرها.

3. ضع هذا في شريط العنوان http: // localhost: 3000 /.

4. ثم أدناه انقر فوق علامة تبويب الرؤوس ، أضف مفتاحًا من نوع المحتوى وقيمة التطبيق / json.

5. يجب أن يظهر النقر فوق الزر إرسال الأزرق الاستجابة ذات الصلة.

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

نقطة واحدة لأسفل ، 4 أكثر للذهاب :)

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

انتقل إلى الجزء 2 →