Plots2: توثيق نظام الرمز للكتابة API

يا @ jywarren هل يمكنني العمل عليها؟

بالتأكيد شكرا لك!

آسف لعدم توثيق الميزة في ذلك الوقت لأنني كنت في عجلة من أمري لإكمال المهام على الجدول الزمني. شكرا لتطوعك للعمل عليها ، @ namangupta01! أود مراجعته بمجرد الانتهاء من التوثيق.

لا مشكلة على الإطلاق! العمل بروح الفريق الواحد!

ryzokuken شكرا لك! :)

jywarrenryzokuken لذا كنت أعمل في هذه المسألة، وكنت أتساءل التي أقوم تملك إلا أن وثيقة عن تصريحات من خلال رمز أي https://github.com/publiclab/plots2/pull/1513/files ؟

@ namangupta01 صحيح! هذه هي العلاقات العامة حيث كتبت بالفعل رمز التعليق من خلال رمز مميز.

مرحبا جميعا! هل يمكنني المساعدة في هذا أيضًا؟ كيف تسير الأمور حتى الآن؟ كنت أفكر في البدء في كتابة وثائق الرمز المميز للتعرف أكثر على واجهة برمجة التطبيقات.

stefannibrasil أعتقد أنه تم التخلي عن هذا في الوقت الحالي ، لذلك قد لا تتردد في المضي قدمًا والعمل على هذا. أخبرنا إذا واجهت أي مشاكل.

شكرًا ، ryzokuken ،

@ sukhbir-singh هل تريد أن تبدأ العمل على هذا أيضًا؟ يمكننا مقارنة عملنا لاحقًا.

بلى! أكيد: ابتسم:
stefannibrasil أنت نشط على

مرحبا jywarren وryzokuken! بعد قراءة المزيد من المستندات المتوفرة هنا ، لدي بعض الأسئلة لطرحها:

• الملفات الموجودة في المجلد app/api/src/ هي المستندات التي يستخدمها Swagger لإنشاء الواجهة ، أليس كذلك؟

• من أجل إنشاء وثائق لمصادقة الرمز المميز ، هل أحتاج إلى إنشاء ملف جديد في المجلد المذكور أعلاه ، يوضح كيف يعمل CommentController على إنشاء الإجراء؟

هذا ما فهمته حتى الآن. سأكون ممتنًا لو تفضلتم بتقديم المزيد من المعلومات حول ذلك. شكرا!

stefannibrasil لتوفير الوقت والجهد ، لقد تجنبت جعل إجراء "التعليق على الرموز المميزة" جزءًا من مواصفات Swagger API الحالية ، وقمت بعمل وظيفة مستقلة في قاعدة شفرة ريلز (في CommentController ، أنت حق) وجعل الطريق لذلك.

لا أعتقد أن Swagger يسمح لك بتوثيق الوظائف الخارجية ، لكن قد أكون مخطئًا.
لذلك ، أعتقد أنه يجب عليك فقط إضافة بعض الوثائق بنفسك في doc/api.md بتنسيق تخفيض السعر ، موضحًا قليلاً كيفية عمل الوظيفة وكيف نتوقع من المستخدمين إضافة تعليقاتهم الخاصة باستخدام نقطة النهاية هذه.

آمل أن يوضح ذلك ، فلا تتردد في طلب توضيح بشأن أي من هذا.

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

لقد أضفت أسئلتي في الوصف ، هل يمكنك إلقاء نظرة ومعرفة ما إذا كان يمكنك مساعدتي؟

لم أتمكن من العثور على الكثير من الوثائق حول الرمز المميز ، يمكنك إخباري بمكان البحث أيضًا ، وهذا من شأنه أن يساعد! :)

@ sukhbir-singh آسف ، أنا لست على علاقة بالمرح ، ولكن إذا كنت تريد ، يمكنك المساهمة في العلاقات العامة أيضًا ، سيكون ذلك رائعًا.

stefannibrasil ، يمكنك هذا الفيديو للحصول على عرض توضيحي يوضح كيفية استخدام ساعي البريد لتقديم طلب بشأن واجهة برمجة التطبيقات للتعليق. : بالون:

رائع ، هل هذا مكتمل ، أم أن هناك المزيد الذي يمكننا التحدث عنه بشأن هذا؟ لا تتردد في إغلاقها إذا تم ذلك! شكرا لكم جميعا!!!

في الواقع ، ربما يمكننا إضافة بعض الإضافات - مثل ، هل يمكننا تحسين POST https://publiclab.org/comment/create/token/id.:format إلى POST https://publiclab.org/comment/create/token/id.json لتوضيح أنه يمكنك تحديد التنسيق من هذا القبيل. وربما يجب علينا الارتباط بمكان رمز API المميز في المصدر؟

https://github.com/publiclab/plots2/blob/master/app/controllers/comment_controller.rb#L48 -L73

jywarren +1 ، هذا يبدو مثاليًا.

مرحبا جميعا! هذه نقاط جيدة ، شكرا! تم دمج PR بالفعل ، سأضيف هذا وأنشئ واحدًا آخر ثم =)

أيضًا ، شكرًا @ sukhbir-singh شكرًا على كل المساعدة هنا!

لا مشكلة...!! سررت بالمساعدة. أنا نشط جدًا على github و gitter و irc ، يمكنك الاتصال بي هناك إذا كنت بحاجة إلى مساعدة في أي حال. : مبتسم: