לונדון, 27 במרץ, 2023 /PRNewswire/ — השיקו עוד תכונה אינטואיטיבית לחבילת התיעוד שלהם. תכונת תיעוד ה-API החדשה מתאימה למפתחים ליצירת תיעוד מלא להפניות API. עם התכונה החדשה, מפתחים יכולים לקחת הפניות API ולייצר תיעוד ידידותי למפתחים.
בהתייחס לתכונה, סאראוואנה קומאר, מנכ”לית ומייסדת Document360, אומרת, “ארגונים מכל הממדים תלויים בממשקי API להזנקת הטרנספורמציה הדיגיטלית שלהם, ותיעוד API הוא קריטי להצלחתם. תכונה זו תהיה מהשורה הראשונה ותיצור חוויה נעימה למפתחים.”
התמיכה החדשה בתיעוד API מגיעה עם התכונות הבאות:
1.ייבוא Swagger/OpenAPI – הוספת הפניות ל-API באמצעות OpenAPI V2 &V3 כדי לקרוא ולהביא את הפרטים הספציפיים מקובצי OpenAPI הקיימים.
2.כתובת URL של קבצים – צור תיעוד API על-ידי הזנת כתובת ה-URL של קובץ ה-OAS המתארח
3.חיפוש רב עוצמה – מאפשר למפתחים למצוא נקודות קצה, תיעוד וסכמות ללא מאמץ באמצעות חיפוש רחב.
4.הפניות API – ממשק קל לשימוש, ניסיון קריאות API וקבלת מידע אמיתי בחזרה, לרבות קודי שגיאה ופרטי כותרת.
5.נסה זאת – מאפשר למשתמשים להריץ בקשות מהדפדפן ולהציג תגובה אמיתית מ-API.
6.עורך ידני – מאפשר למשתמשים ליצור מקטע הפניה מדהים ואינטראקטיבי של API.
7.יצירת דוגמאות קוד בזמן אמת – מאפשר למפתחים ליצור דגימות קוד באופן מיידי.
8.סנכרון מחדש – עדכון תיעוד ה-API עם פונקציונליות סנכרון מחדש.
9.יומנים – הצגת השלבים המתועדים בסדר כרונולוגי, עם פרטים כגון סוג המקור, התאריך והסטטוס.
מאניקאנדאן סובאמאניאם, מנהל הנדסה, Document360, מסביר עוד, “הממשק הפשוט והאינטואיטיבי שלנו עוזר למפתחים לנסות נקודות קצה של API בזמן אמת ומייצר דוגמאות קוד בשפות שונות. עם הסנכרון החכם, ניתן לשמור את תיעוד ה-API שלך מעודכן. הוא משולב ללא מאמץ עם תיעוד מאגר הידע והופך לפתרון אחד לכל צורכי התיעוד שלך.”
אודות Document360
Document360 הוא פתרון מאגר ידע שהונדס עבור חברות בצמיחה, לצורך מאגר ידע מקוון בשירות עצמי ללקוחות ולעובדים (שאליו ניתן לגשת באופן ציבורי או פרטי). הוא מגיע עם אתר מאגר ידע מובנה ופורטל מאגר ידע לניהול התוכן על-ידי עורכים ומבקרים. חברות יכולות אפילו ליצור מאגר ידע המשלב את היתרונות של הפורטל והאתר.
למידע נוסף אודות חדשות אלו, בקרו באתר www.document360.com.
