#توثيق API

#مقدمة

تُنشئ هذه الإضافة توثيق NocoBase HTTP API بالاعتماد على Swagger.

#التثبيت

هذه إضافة مدمجة، لا تتطلب التثبيت. ما عليك سوى تفعيلها للبدء في استخدامها.

#تعليمات الاستخدام

#الوصول إلى صفحة توثيق API

http://localhost:13000/admin/settings/api-doc/documentation

#نظرة عامة على التوثيق

• توثيق API الكلي: /api/swagger:get
• توثيق API الأساسي: /api/swagger:get?ns=core
• توثيق API لجميع الإضافات: /api/swagger:get?ns=plugins
• توثيق كل إضافة: /api/swagger:get?ns=plugins/{name}
• توثيق API للمجموعات المخصصة من قبل المستخدم: /api/swagger:get?ns=collections
• الموارد المحددة ${collection} والموارد المرتبطة بها ${collection}.${association}: /api/swagger:get?ns=collections/{name}

#دليل المطور

#كيفية كتابة توثيق Swagger للإضافات

أضف ملف swagger/index.ts في مجلد src الخاص بالإضافة بالمحتوى التالي:

export default {
  info: {
    title: 'NocoBase API - Auth plugin',
  },
  tags: [],
  paths: {},
  components: {
    schemas: {},
  },
};

للاطلاع على قواعد الكتابة التفصيلية، يرجى الرجوع إلى توثيق Swagger الرسمي.