אודות מציג מפרטי OpenAPI / Swagger — מדריך מפורט
מציג ה-OpenAPI הוא כלי לקריאת תיעוד בצד הלקוח לבדיקה וחקירה של חוזי RESTful API. הכלי מציג ומעבד מפרטי Swagger 2.0 ו-OpenAPI 3.0 / 3.1 בפורמט JSON או YAML ללא צורך בהתקנה מקומית של Swagger UI או בתלות בשירותי ענן.
הוא מספק ניווט נקי ומקובץ בסרגל צד עבור כל נקודות הקצה (endpoints), ומציג נתיבים, מתודות HTTP (GET, POST, PUT, DELETE), פרמטרים בכותרות (headers), מחרוזות שאילתה (query strings), גופי בקשה מובנים, קודי תגובה של HTTP וסכמות נתונים.
תכונות ויכולות עיקריות
- תמיכה במפרטי Swagger 2.0 ו-OpenAPI 3.0 / 3.1 בפורמטים JSON ו-YAML
- סרגל צד אינטראקטיבי המציג נקודות קצה מסווגות, מתודות HTTP וקודי סטטוס
- פענוח עמוק של הפניות `$ref` בסכמה להצגת מודלי נתונים מקוננים ואילוצי מאפיינים
- ניתוח 100% בצד הלקוח במצב לא מקוון השומר על אבטחת חוזי API ארגוניים וקנייניים
כיצד להשתמש
- 1
הדבק את טקסט ה-`swagger.json` או `openapi.yaml` שלך, או העלה את קובץ המפרט ישירות.
- 2
עיין בתיעוד ה-API המובנה המוצג במציג האינטראקטיבי.
- 3
הרחב כל נקודת קצה כדי לבדוק כותרות בקשה, סכמות של גוף הבקשה (payload) ודוגמאות תגובה.
שימושים נפוצים
- ← ביקורת ובדיקה של הגדרות API בצד השרת ללא צורך בהקמת שרת Swagger UI ייעודי
- ← בדיקת תקינות (sanity-check) של מפרטי OpenAPI שנכתבו ידנית לאיתור מצביעי `$ref` שגויים
- ← אספקת מראי מקום מדויקים של סכמות למפתחי פרונטאנד במהלך אינטגרציות API
כלים קשורים
מחולל תגיות Meta (SEO)
יצירת תגיות מטא מלאות עבור Open Graph, Twitter Cards ותגיות SEO בסיסיות.
מחולל .gitignore
יצירת קובצי .gitignore מותאמים אישית לשפות פיתוח, סביבות עבודה ומערכות הפעלה.
מחולל רישיונות קוד פתוח
יצירת קובצי רישיון פופולריים (MIT, Apache 2.0, GPL v3, BSD) עם פרטי הפרויקט.
מחולל README.md
יצירת תבנית README מקיפה ומעוצבת לפרויקטים בקוד פתוח עם סמלילים ותיאורים.
מחולל הודעות Conventional Commits
יצירת הודעות Git Commit תקניות לפי מפרט Conventional Commits (feat, fix, chore וכו').
מחשבון גרסאות SemVer
חישוב ובדיקת גרסאות סמנטיות (Semantic Versioning), טווחי תאימות ושדרוגים.
שאלות נפוצות ופרטיות
האם כלי זה יכול לקרוא מפרטי YAML ישירות?
כן. מנתח YAML מובנה מעבד הן מפרטי חוזי OpenAPI בפורמט `.yaml` והן בפורמט `.json` לחלוטין בתוך הדפדפן.
האם מפרט ה-API הקנייני שלי מועלה לשרתים חיצוניים?
לא. כל ניתוח המסמכים ורינדור הסכמות מתבצעים אך ורק בתוך זיכרון הדפדפן המקומי שלך.