99九九成人免费视频精品,亚洲国产综合精品,a成人毛片免费观看

您可以使用 Spectral 創(chuàng)建規(guī)則集，這些規(guī)則集可以具有自定義規(guī)則甚至自定義功能！

這些自定義規(guī)則看起來有點像這樣：

規(guī)則：schema-names-pascal-case：描述：模式名稱必須以 PascalCase 格式書寫消息：'{{property}} 不是 PascalCase：{{error}}' 推薦：true 類型：style 給定：'$.components.schemas.~' 然后：功能：模式 functionOptions：匹配：'^[AZ][a-zA-Z0-9]$'

這個比較流行。OpenAPI 并不關(guān)心你如何將模型首字母大寫，但很多代碼生成器會使用模型名稱來編寫代碼，而不一致的類名會讓人不爽。

讓我們更進一步：

規(guī)則：paths-kebab-case：描述：路徑是否應為 kebab-case。消息：'{{property}} 不是 kebab-case：{{error}}'嚴重性：警告推薦：true 給定：$.paths[*]~ 然后：功能：模式 functionOptions：匹配：“^(/[a-z0-9-{}]+)+$”

此規(guī)則實際上超越了 API 描述的元數(shù)據(jù)，而是著眼于實際的 API 設(shè)計本身。這意味著“路徑”（接口）必須帶連字符，因此/recent-files是可以的，但/recent_files不行。

您可以開始真正發(fā)揮創(chuàng)造力。

規(guī)則：no-x-headers：描述：“請不要使用帶有 X- 的標題”消息：“標題不能以 X- 開頭，因此請為 {{property}} 找到一個新名稱。更多信息：https://tools.ietf.org/html/rfc6648”推薦：true 給定：“$..parameters.[?(@.in === 'header')].name”然后：功能：模式 functionOptions：notMatch：'^(x|X)-'

我不知道為什么，但在任何給定 API 的生命周期的某個時刻，一些開發(fā)人員會建議添加 X-Foo 標頭，盡管十多年來它一直導致問題。好吧，我們可以用這條規(guī)則把他們拒之門外。

如果盡早完成，這將在開發(fā)過程中塑造實際的 API。如果您先編寫代碼，那么好吧，您必須返回并更改一堆代碼。希望您沒有發(fā)布它，因為現(xiàn)在您需要為/recent_files /recent_files進行大量重定向。如果您使用API 設(shè)計優(yōu)先工作流程，那么當您剛剛獲得一些 YAML 時，您會盡早注意到這一點，并且您的 API 首先得到構(gòu)建。

由于 Spectral 是一個 CLI/JS 工具，因此可以通過各種方式來執(zhí)行此樣式指南。

在git hook中
在 JS 測試套件中
關(guān)于持續(xù)集成導致構(gòu)建失敗的錯誤

如果您使用Stoplight Studio，那么它就會直接嵌入到編輯器中，因此設(shè)計 API 的人可以立即正確完成所有操作。無需按 Alt-Tab 鍵轉(zhuǎn)到 CLI 或等到 PR 完成。

我正在努力抽出時間從Heroku或PayPal獲取樣式指南，并將它們轉(zhuǎn)換成一個巨大的示例規(guī)則集。至少，我可以從中汲取一些靈感，用于我正在整理的新規(guī)則集：OpenAPI Contrib > 樣式指南。這應該是一個有趣的社區(qū)努力。

Spectral 還有一個GitHub Action，我們正在努力改進它。評論范圍和建議即將推出！

GraphQL Doctor 和 Schema Linter的區(qū)別？

GraphQL 有自己的內(nèi)置類型系統(tǒng)，其中有一些與基于 OpenAPI / JSON Schema 相同類型的關(guān)鍵字。

GraphQL 使一些設(shè)計決策變得更容易，比如如何處理關(guān)系。無需在嵌套/嵌入相關(guān)資源、使用復合文檔內(nèi)聯(lián)所有內(nèi)容或使用超鏈接鏈接到相關(guān)數(shù)據(jù)之間做出選擇，GraphQL 會為您做出決定。盡管如此，在 GraphQL 做出的默認決策之外，仍可能出現(xiàn)許多不一致的情況。GraphQL 人員無法逃避 lint 的需要，但幸運的是，存在一個很棒的 linter：GraphQL Schema Linter。

也可以為此編寫自定義規(guī)則，這樣您就可以在 CI 中自動化您的樣式指南。我看不到機器人或 GitHub Action，但它們并不難組合在一起。

GraphQL 領(lǐng)域中一款擁有出色機器人的架構(gòu)工具是 GraphQL Doctor。它似乎希望在總體上提供更多幫助，但到目前為止，它專注于檢測重大更改。與任何類型的系統(tǒng)一樣，謹慎發(fā)展和魯莽更改之間存在一條細線，而 GraphQL Doctor 會發(fā)現(xiàn)后者。

graphql doctor bot 的預覽，評論 github pull request，顯示發(fā)生故障的行

如果這兩個工具能夠合并就好了，或者 GraphQL Doctor 機器人可以支持 GraphQL Schema Linter，但就目前而言，它是一個兩站式商店。

Google 的“API Linter”是什么？

Google 在 API 領(lǐng)域做了一些非常有趣的工作。他們是 API 領(lǐng)域首批不斷解釋“有時你需要 REST，有時你需要 RPC”的大公司之一，并且他們堅持使用適用于gRPC 和 HTTP 的通用工具。API linter 在 protobuf 表層上運行，但可以設(shè)置為與 HTTP 端點一起工作：