איך מציגים מסמך OpenAPI
הציגו תיאור OpenAPI 3.0 או 3.1 בפורמט JSON כרשימה של מתודות, נתיבים, תקצירים, שמות פרמטרים וקודי תגובה. הכלי אינו פונה לשירות המתואר, כך שאפשר לעיין במסמך ה־API גם ללא חיבור לרשת.
דוגמה
פעולת get תחת /items מוצגת בשורה GET /items, לצד קודי התגובה הרשומים שלה. סימון deprecated מוצג במפורש, והפעולה אינה מוסתרת.
לפני השימוש בתוצאה
הקלט חייב להיות JSON. הכלי מציג את מבנה המסמך; הוא אינו בודק עמידה בתקן OpenAPI ואינו לקוח API. הפניות מוצגות אך אינן נפתרות, והכלי אינו מסיק מהן את דרישות האימות או את תקינות הסכמות.
עודכן
ציטוט העמוד
ToolOctopus. “צפייה במסמכי OpenAPI.” עודכן 7 באוקטובר 2026. https://tooloctopus.com/he/צפייה-במסמכי-openapi.
אם ההנחיות דורשות זאת, יש להוסיף תאריך גישה.
הציטוטים מעוצבים באמצעות citeproc-js של Frank Bennett וסגנונות Citation Style Language. רישיון וקוד מקור.