API 參考工作流程

本機閱讀 OpenAPI,不隱藏無法解析的參照

操作清單有助於交接,但空欄位可能代表來源缺資料,也可能是參照無法解析;應明確區分。

內容更新: · 維護者與修正回報

先確認宣告版本與範圍

檢視器接受宣告 OpenAPI 3.0.x 或 3.1.x 的 JSON,需有 info.title、info.version 與 paths。Swagger 2.0 及 OpenAPI 3.2 需要不同處理,因此拒絕。可解析支援版本不等於完整規格驗證。

最多貼上 1 MiB、1,000 個操作。目錄每頁顯示 50 筆,搜尋涵蓋 method、path、summary、operationId 與 tags。目錄篩選不會縮減完整匯出。

明確追查繼承

路徑層參數會套用到操作;操作參數的 name 與 in 同時相同時覆寫路徑參數。Servers 依操作、路徑、文件層依序採用,清單不存在或為空時使用規格預設 /。操作 security 取代根層設定,明確的空陣列也會移除繼承需求。

應一起檢查有效 parameters、responses、requestBody、servers 與 security。顯示的 security 只描述文件,不執行登入、授權、連線或確認 API 實際執行規則。

將 unresolved 參照視為未完成證據

本機 #/ JSON Pointer 只經 own properties 解析,先解析 URI fragment 百分比編碼,再解析 ~0 與 ~1,深度上限 40,共用工作預算 100,000 個值。外部參照、anchor、缺少目標、循環與超限都保留 unresolved 標記,不透過 HTTP 取得參照。

不合併 $ref 的 sibling,並顯示警告。此有界政策不會假裝已完整套用各版本參照與 JSON Schema 語義;請保留來源文件,需要完整正確性時改用辨識版本的規格驗證器。

分享前檢查匯出

說明採 React 文字,不渲染 Markdown 或 HTML。JSON/Markdown 匯出包含操作細節及完整警告,頁面只預覽前 50 個警告;範例及 server URL 仍可能含秘密或私有基礎設施名稱,本機處理不等於自動遮罩。

輸入只留本頁記憶體,不上傳、持久儲存、放入網址或輸入分析。修改即撤銷報告。本指南來源快照日期為 2026-10-09;下載檔與剪貼簿由裝置管理。

路徑參數:{"name":"id","in":"path"}
操作中相同的 name/in 組合會覆寫它。
操作 security: [] 會移除根層繼承的安全需求。

資料可信度

資料來源