#תיעוד API

#מבוא

התוסף מפיק תיעוד API של NocoBase HTTP בהתבסס על 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.