תיעוד איכותי חשוב כדי להקל על API להבין, ליישם ולשמר. הקמנו דור אוטומטי של תיעוד המבוסס על מפרט OpenAPI באמצעות Swagger UI ו-Redoc, שניים מכלי ההדמיה הפופולריים ביותר של API.
זה מאפשר לך לספק למפתחים ממשק אינטראקטיבי שבו אתה יכול ללמוד את המבנה של שיטות, שאילתות מבחן, ולהתחבר במהירות ל API שלך.
מה כלול בתיעוד
| המדור | תיאור |
|---|---|
| נקודות סוף ושיטות | רשימה מלאה של מסלולים, שיטות HTTP, פרמטרים, כותרות |
| בקשות/תגובות לדוגמה | תסריטים לתלתלים, דוור, JavaScript, פייתון ושפות נוספות |
| אישור | תמיכה במפתח JWT, OAuth2, API ישירות מהממשק |
| דיאגרמות מתקן | תיאור מודלים, מבנים מקוננים ודרישות מידע |
| קודי שגיאה | כל המדינות האפשריות עם הסברים |
הכלים בהם אנו משתמשים
Swagger UI - תיעוד אינטראקטיבי בדפדפן, עם היכולת לבדוק
Redoc הוא ממשק קריא, סטטי אידיאלי לפרסום באתר
OpenAPI 3. 0/3. 1-The פורמט BOM שעליו הכל מבוסס
דור אוטומטי מקוד - הערות, תיאורים, גרסאות ועדכוני תיעוד באופן אוטומטי
ייצוא ל ־ JSON/YAML/HTML
הטבות לצוות ולשותפים
מאיץ עלייה למטוס של מפתחים חדשים
הפחתת שגיאות אינטגרציה
תמיד עדכני, מסונכרן קוד תיעוד
התחלה מהירה לאינטגרציה ללא תמיכה טכנית
פרסום קל של תיעוד על פורטלים ציבוריים או פרטיים
איפה חשוב במיוחד
אפליקציות פתוחות למפתחים חיצוניים
API פנימי עם פיתוח פעיל
פלטפורמות עם אינטגרציית B2B ו ־ SDKs
שירותים עם דרישות לתקנות ואימות מזימות
Swagger ו-Redoc הם תקן התיעוד הבא של API. אנחנו נקים את הדור, עדכון ופרסום של תיעוד כך שכל מפתח יכול להתחיל אינטגרציה עם API שלך בעניין של דקות.