أنا أستخدم واجهة برمجة تطبيقات Discourse لاستخراج المنشورات من منتدى. أحتاج إلى مساعدة في فهم معاني الحقول التي تعيدها الواجهة. على سبيل المثال، حقل post_type في كل post هو رقم. ما هي القيم الصالحة وماذا تعني؟ وبالمثل، فإن id تحت actions_summary هو رقم. هناك حقول أخرى مثل reads و score وما إلى ذلك، وأنا غير واضح بشأنها. أي تلميحات حول المكان الذي يمكنني الحصول فيه على هذه المعلومات. شكرًا!
إذا كان لديك إضافة مستكشف البيانات مُثبّتة على موقعك، فيمكنك الحصول على تفاصيل حول أرقام الرموز المستخدمة عن طريق تمرير الماوس فوق الإدخالات:
على سبيل المثال، عند تمرير الماوس فوق حقل posts post_type، تظهر القيم التالية:
- عادي: 1
- إجراء مشرف: 2
- إجراء صغير: 3
- همسة: 4
باستثناء مستكشف البيانات، فإن المكان الوحيد الذي أعرفه للعثور على هذه المعلومات هو في كود Discourse. على سبيل المثال، للعثور على معنى كل action_type من جدول user_actions، اكتب UserAction.types في وحدة تحكم Rails. وهذا يعيد القيم التالية:
{:like=>1, :was_liked=>2, :bookmark=>3, :new_topic=>4, :reply=>5, :response=>6, :mention=>7, :quote=>9, :edit=>11, :new_private_message=>12, :got_private_message=>13, :solved=>15, :assigned=>16}
شكرًا لك @simon! هذه طريقة مثيرة للاهتمام للحصول على هذه المعلومات. قمت ببعض البحث بناءً على اقتراحاتك ووجدت هذا الجزء من الكود الخاص بـ user_actions، لكن لم أستطع العثور على شيء مشابه لـ post_type رغم البحث المكثف. كنت آمل أن يكون كل حقل يتم إرجاعه عبر واجهة برمجة التطبيقات موثقًا في مكان ما، على الأقل للحقول المهمة التي تحمل دلالات كبيرة.
هذا مفهوم. ومع ذلك، يوجد كود مشابه. وهو موجود هنا: discourse/app/models/post.rb at main · discourse/discourse · GitHub. إن هيكل قاعدة بيانات Discourse متسق للغاية. نأمل أن يساعدك هذا في تعويض نقص التوثيق.
لست متأكدًا من أن كل حقل يتم إرجاعه عبر واجهة برمجة التطبيقات سيُوثَّق، لكن توثيق الأماكن المختلفة التي تُرجع فيها أكواد الأرقام يبدو أمرًا مهمًا. ومن الأمثلة على ذلك:
Post.typesUserAction.typesNotification.typesNotificationLevels.allUserOption.email_level_types
إذا قررنا المضي قدمًا في هذا الأمر، فأنا لست متأكدًا من أفضل مكان لتوثيق ذلك. ربما يكون على https://docs.discourse.org/، لكن من الممكن أن تكون هناك مشاكل تقنية في القيام بذلك.
شكرًا لك يا @simon! نعم، سيكون من المفيد جدًا سرد الأسماء الإنجليزية/الوصوفات في سطر واحد للأرقام الرمزية. هل هناك مكان يمكنني فيه تقديم طلب بذلك؟
أتفق على أن هذه الحقول تحتاج إلى توثيق. سأخصص هذا الموضوع لنفسي وأتأكد من إتمامه.