طريقة برمجية للحصول على جميع نقاط النهاية API الخاصّة بمثيلتي؟

[RGJ (Richard - Communiteq)]

@mcwumbly

إذًا، ما هي ضمانات الاستقرار التي يمكننا تقديمها لواجهة برمجة التطبيقات الخلفية لدينا؟

أعتقد أن هذه مسؤولية يجب أن تتناولها وثائق واجهة برمجة التطبيقات.

يجب معالجة ضمانات الاستقرار عن طريق الإصدار القياسي لواجهة برمجة التطبيقات.

@mcwumbly

أولاً، كنوع من نموذج ذهني عالي المستوى، سأصف الأشياء على هذا النحو:

• نقطة الدخول الرئيسية للتوثيق موجودة هنا، كما أشرت: Documentation - Discourse Meta
• بالنسبة لتوثيق المطورين، فهو هنا، أو ربما الأفضل من ذلك، هنا: Introduction to Discourse Development
• وثائق واجهة برمجة التطبيقات هي مجموعة فرعية من وثائق المطورين، وتقع هنا: https://docs.discourse.org/

أود أن أسمي وثائق واجهة برمجة التطبيقات وثائق بدلاً من مواصفات، لكنني أتفق على أنها لا تزال مجموعة فرعية من وثائق المطورين لدينا. عنوان URL لهذه الوثائق غريب… سيكون من المنطقي أكثر أن تعيش وثائقنا الكاملة هناك أو أن يكون هذا إعادة توجيه إلى https://meta.discourse.org/c/documentation/10، وأن تكون هناك علامة واضحة من Introduction to Discourse Development إلى وثائق واجهة برمجة التطبيقات.

هذا الموضوع ليس حول مكان وجود التوثيق - بل هو حول كيفية توثيق واجهة برمجة التطبيقات. ما هو مفقود هو تنسيق موحد وقابل للقراءة آليًا مثل OpenAPI.

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