יצירת API למערכת

תיאור כללי

הAPI יאפשר לעשות אוטומציה לפעולות שכבר ניתן לעשות במערכת, או לקבל נתונים בפורמט JSON

מה ההצעה כוללת?

  1. חשיפת routes ספציפיים לבקשות GET,POST אולי בהמשך גם ל-PATCH,DELETE
  2. יצירת מספר מבני נתונים שניתן לגשת אליהם
  3. הרשמה ושימוש בשירות רק עם token
  4. יצירת מגבלה על כמות הבקשות שניתן לעשות כדי שלא יוצף
  5. פרסום דוקומנטציה והסבר על השימוש

בשלב הראשוני הscope של הtoken יהיה אישי - כלומר אפשר יהיה לבצע שינויים ולמשוך נתונים רק מהלוח שנה שלי. אני חושב שהרחבת הscope של הtoken זה כבר בסדר גודל עבודה של עוד טיקט :stuck_out_tongue:

כולל שינויים בקוד? אם כן, איפה?

  1. הוספת route לדוקומנטציה, הגשת html
  2. יצירת כפתור שמג’נרט token ומציג אותו רק אחרי הלחיצה על הכפתור (מחבר בין היוזר לtoken), אחרי שקיים טוקן הכפתור הופך להיות כפתור שמאפשר להציג את הtoken ולא ליצר. (אולי בפיתוח לעשות עוד כפתור שמאפשר יצירת רפרוש לערך הtoken)
  3. חשיפה של routes לapi
  4. כתיבת פונקציות לroutes (בשאיפה שהpost זה לחבר פשוט לפונקציות קיימות)
  5. מנגנון וידוא token
  6. מנגנון הגבלת שימוש

האם יהיו שינויים במסד הנתונים? אם כן, איפה?

הוספת טבלה עם כל הtoken שאושרו, אולי לאסוף מידע לפי טוקן על הבקשות שהוגשו וכו’
בשלב הראשון - חיבור בין המשתמש לטוקן

האם יהיה שינוי ב־frontend? אם כן, איפה?

הוספת כפתור / אפשרות “מפתחים” בעמוד הפרופיל שמוביל אל route שמגיש את הדוקומנטציה שבתחתית שלה אפשרות “להרשם” לשירות ולקבל token.

אילו טסטים יגרמו לטיקט להיחשב כ"עובד", ויאפשרו לנו לסגור את הטיקט ולהגדיר את המשימה כהושלמה?

  1. הרשמה למערכת עובדת
  2. זיהוי טוקן שאושר עובד
  3. בקשות הPOST לroutes החשופים מבצעות את הפעולה המשויכת (למשל - יצירת אירוע)
  4. בקשות הGET לroutes החשופים מחזירות את הנתונים הנכונים
  5. נמנעת הצפת בקשות לAPI
  6. עמוד הדוקומנטציה וההסבר מוגש ומציג את כל התוכן הרצוי

נ.ב. אעדכן ואבחר את הנתונים שייחשפו והפעולות שניתן יהיה לעשות בהתאם להצעות שיאושרו, ובמידה והטיקט יאושר אפרט בדיוק.
כרגע המטרה היא בסיסית: 1) יצירת אירוע בלוח שנה (עם אפשרות למשתנים שאפשר בפרונט)
2) שליפת אירוע מהלוח שנה

8 לייקים

זה רעיון מצוין!
שים לב שממילא רוב הפונקציונליות תבנה במשהו תואם API שכזה, ככה שרוב העבודה ככה"נ תהיה על token ויצירת גישה דרכו

מחכה לבדיקה?
או לעלות אישיו ישר?

חשוב להעלות את זה שאתה מחכה לבדיקה, אני עובר לעומק על הטיקט ורואה שלא חסר כלום לפני שאני מוציא אותך לדרך.
זה נראה אחלה, לך על זה :slight_smile: