#pkg: "@nocobase/plugin-data-source-rest-api"

#מקור נתונים REST API

#מבוא

תוסף זה מאפשר לכם לחבר נתונים ממקורות REST API בצורה חלקה.

#התקנה

תוסף זה הוא תוסף מסחרי, ודורש העלאה והפעלה דרך מנהל התוספים.

#הוספת מקור נתונים REST API

לאחר הפעלת התוסף, תוכלו להוסיף מקור נתונים REST API על ידי בחירה בו מתוך תפריט "הוסף חדש" (Add new) בניהול מקורות הנתונים.

הגדירו את מקור הנתונים REST API.

#הוספת אוסף

ב-NocoBase, משאב RESTful ממופה ל-Collection (אוסף), לדוגמה, משאב Users.

GET /users
POST /users
GET /users/1
PUT /users/1
DELETE /users/1

נקודות קצה אלו של ה-API ממופות ב-NocoBase באופן הבא:

GET /users:list
POST /users:create
POST /users:get?filterByTk=1
POST /users:update?filterByTk=1
POST /users:destroy?filterByTk=1

למדריך מקיף על מפרטי עיצוב ה-API של NocoBase, עיינו בתיעוד ה-API.

עיינו בפרק "NocoBase API - Core" למידע מפורט.

הגדרות ה-Collection עבור מקור נתונים REST API כוללות את הדברים הבאים:

#List

מפו את הממשק לצפייה ברשימת אוספים.

#Get

מפו את הממשק לצפייה בפרטי אוסף.

#Create

מפו את הממשק ליצירת אוסף.

#Update

מפו את הממשק לעדכון אוסף.

#Destroy

מפו את הממשק למחיקת אוסף.

יש להגדיר את ממשקי ה-List וה-Get באופן חובה.

#איתור באגים ב-API

#שילוב פרמטרי בקשה

דוגמה: הגדירו פרמטרי חלוקה לעמודים עבור ה-API של List. אם ה-API של צד שלישי אינו תומך בחלוקה לעמודים באופן טבעי, NocoBase יחלק לעמודים על בסיס נתוני הרשימה שאוחזרו.

שימו לב, רק משתנים שנוספו בממשק ייכנסו לתוקף.

תוכלו ללחוץ על Try it out כדי לבצע איתור באגים ולצפות בתגובה.

#המרת פורמט תגובה

פורמט התגובה של ה-API של צד שלישי עשוי שלא להיות בסטנדרט של NocoBase, ויש להמיר אותו לפני שיוצג כראוי בממשק המשתמש.

התאימו את כללי ההמרה בהתאם לפורמט התגובה של ה-API של צד שלישי, כדי להבטיח שהפלט תואם לסטנדרט של NocoBase.

תיאור תהליך איתור הבאגים

#משתנים

מקור הנתונים REST API תומך בשלושה סוגי משתנים לשילוב API:

• משתני מקור נתונים מותאמים אישית
• משתני בקשת NocoBase
• משתני תגובה של צד שלישי

#משתני מקור נתונים מותאמים אישית

#בקשת NocoBase

• Params: פרמטרי שאילתת URL (Search Params), המשתנים בהתאם לממשק.
• Headers: כותרות בקשה מותאמות אישית, המספקות בעיקר מידע X- ספציפי מ-NocoBase.
• Body: גוף הבקשה.
• Token: אסימון ה-API עבור בקשת NocoBase הנוכחית.

#תגובות של צד שלישי

נכון לעכשיו, רק גוף התגובה זמין.

להלן המשתנים הזמינים עבור כל ממשק:

#List

#Get

#Create

#Update

#Destroy

#הגדרת שדות

מטא-נתונים של שדות (Fields) נשלפים מנתוני ממשק ה-CRUD של המשאב המותאם, כדי לשמש כשדות של ה-Collection.

שליפת מטא-נתונים של שדות.

שדות ותצוגה מקדימה.

עריכת שדות (בדומה למקורות נתונים אחרים).

#הוספת בלוקים של מקור נתונים REST API

לאחר שה-Collection הוגדר, תוכלו להוסיף בלוקים לממשק.