国产高清在线精品一区a,国产精品国产亚洲精品不卡,久久综合给合久久狠狠狠97色

由于性能是成功的關(guān)鍵指標(biāo)，并且導(dǎo)出引擎經(jīng)過了翻新，我們希望逐步全面地測試我們的系統(tǒng)。我們首先在 UI 中添加了一個(gè)新的導(dǎo)出選項(xiàng)（如果出現(xiàn)問題，客戶可以禁用該選項(xiàng)）以開始產(chǎn)生流量。為了幫助我們識(shí)別極端情況，我們將導(dǎo)出指向“最全面、符合標(biāo)準(zhǔn)和最新的機(jī)器可讀 API 定義目錄”（可在此處獲得： https:?//github.com/APIs-guru/openapi-directory），并對(duì)原始文檔和我們的新導(dǎo)出運(yùn)行了頻譜。在許多情況下，我們發(fā)現(xiàn)使用新導(dǎo)出時(shí)驗(yàn)證錯(cuò)誤的數(shù)量顯著減少。在大多數(shù)情況下，這是清理 x-examples 和其他從 OAS2.0 更改為 OAS3.X 的屬性的結(jié)果。

便于使用

由于我們客戶的目標(biāo)是提取完整且有效的定義文件（OAS 和 JSON Schema）并將其集成到下游工具中，因此 Catalog API 需要提供完全獨(dú)立的“捆綁”導(dǎo)出，無需外部引用或依賴項(xiàng)。Catalog API 不是簡單地內(nèi)聯(lián)取消引用 $refs，而是創(chuàng)建可重復(fù)使用的“組件”（適用于 OAS3.X）或“定義”（適用于 OAS2）。這保留了各種工具（例如 SDK 生成）中使用的重要參數(shù)和模型名稱。

（左側(cè)為原始組件庫參考，右側(cè)為捆綁導(dǎo)出）

與 API 身份驗(yàn)證和版本控制類似，還有一些其他“基礎(chǔ)”設(shè)計(jì)決策：

標(biāo)準(zhǔn)化錯(cuò)誤模型– 我們采用了RFC7807。但是，我了解到，最好為不同的錯(cuò)誤情況創(chuàng)建不同的模型，即使它們具有相同的屬性，因?yàn)檫@些模型將由 SDK 生成器使用。
速率限制– 保護(hù)您自己的系統(tǒng)并為您的客戶提供限制自身速率所需的信息。常用的 x-rate-limit、x-rate-limit-remaining 和 x-rate-limit-reset 可以完成這項(xiàng)工作。
請求標(biāo)識(shí)符– 您、您的支持團(tuán)隊(duì)和工程師都會(huì)感激簡單的 Stoplight-Request-Id響應(yīng)標(biāo)頭所提供的附加上下文。將此標(biāo)識(shí)符包含在所有相關(guān)日志中，并培訓(xùn)您的客戶將其包含在您的支持請求中，以使調(diào)試變得輕而易舉。

在設(shè)計(jì)階段，您可能會(huì)花費(fèi)最多時(shí)間充實(shí)端點(diǎn)。由于 Stoplight 本身是圍繞項(xiàng)目及其內(nèi)容組織的，因此我們首先將 /projects/ 作為主要資源。指定分支（對(duì)于 Web 項(xiàng)目，也稱為“版本”）或提交是必要的子資源，最后使用 /export/ 命令，后跟要導(dǎo)出的目標(biāo)的文件路徑。可選地，有一個(gè) include_internal 查詢字符串參數(shù)，它將包含或排除標(biāo)有 x-internal 的對(duì)象（默認(rèn)為 true）。我們相信最終結(jié)果直觀且易于緩存。