react chat api
1.0.0
API لتطبيق الدردشة لدورة DogeCodes React.
هذا هو خادم API بسيط ينفذ المنطق المطلوب لتصحيح العمل لتطبيق DogeCodes React Chat.
لتشغيل هذا الخادم محليًا، يجب أن تتوفر لديك هذه المتطلبات:
استخدم الأوامر التالية لتشغيل خادم API هذا محليًا:
git clone https://github.com/dogecodes/react-chat-api.git
cd react-chat-api
npm install
npm run start:dev # or `npm start` for production ملحوظة: لا تنس أن تبدأ mongod للاتصال بقاعدة البيانات.
الإصدار الحالي من API هو v1 ، لذا تحتاج إلى تحديد إصدار API قبل كل مسار. على سبيل المثال:
http://localhost:8000/v1/users/me
http://localhost:8000/v1/chats
فيما يلي خريطة لمسارات HTTP الخاصة بواجهة برمجة التطبيقات:
/ — المسارات المتعلقة بالمصادقة./signup POST - إنشاء مستخدم جديد باستخدام username وكلمة password ./login POST - قم بتسجيل دخول المستخدم باستخدام username وكلمة password ./logout GET — تسجيل خروج المستخدم النشط./users - الطرق المتعلقة بالمستخدمين./users GET - استرداد البيانات حول جميع المستخدمين./users/me GET - استرداد بيانات المستخدم الخاصة بي./users/me POST - قم بتحديث معلومات المستخدم الخاصة بي ( username firstName lastName city )./users/:id GET - استرداد معلومات حول المستخدم باستخدام :id محدد./chats - الطرق المتعلقة بالدردشات./chats GET - استرداد المعلومات حول جميع الدردشات./chats POST — إنشاء دردشة جديدة title محدد ./chats/my GET - احصل على قائمة بجميع محادثات المستخدم./chats/:id GET - احصل على معلومات الدردشة من خلال الرسائل بواسطة :id دردشة محدد./chats/:id POST - أرسل رسالة جديدة للدردشة مع :id محدد./chast/:id DELETE - احذف الدردشة ذات :id محدد . يمكن لمنشئ الدردشة فقط حذفها./chats/:id/join GET - انضم إلى الدردشة باستخدام :id محدد./chats/:id/leave GET - اترك الدردشة باستخدام :id محدد.إذا كنت تستخدم Insomnia لتصحيح أخطاء واجهات برمجة التطبيقات، فيمكنك تنزيل نسخة احتياطية لمساحة العمل:
تحميل الرمز البريدي
تقوم واجهة برمجة التطبيقات (API) هذه أيضًا بإصدار بعض أحداث المقبس.io والاستماع إليها.
يتطلب اتصال المقابس المصادقة باستخدام رمز الوصول. فيما يلي مثال على إنشاء اتصال مآخذ التوصيل:
import SocketIOClient from 'socket.io-client' ;
socket = SocketIOClient ( 'path/to/api' , {
query : {
token : '...your access-token here...' ,
} ,
} ) ;وهنا قائمة الأحداث:
new-message - تنبعث عندما يرسل شخص ما رسالة جديدة إلى دردشة معينة.new-chat - تنبعث عندما يقوم شخص ما بإنشاء دردشة جديدة.deleted-chat - تنبعث عندما يقوم شخص ما بحذف محادثة. connection - اتصال عميل المقبس.io.mount-chat - قم بتثبيت العميل للاستماع إلى الرسائل في الدردشة باستخدام :chatId محدد.unmount-chat — إلغاء تمكين العميل من الاستماع إلى الرسائل في الدردشة باستخدام :chatId محدد.send-message - إرسال رسالة تحتوي على content للدردشة معه معهد ماساتشوستس للتكنولوجيا © دينيس دوفان
