2017-09-29 110 views
1

我們正在使用Swagger從源代碼生成API文檔。我現在想知道是否有任何工具會自動檢查生成的OpenAPI文檔(= Swagger JSON)與RESTful API設計最佳實踐的符合性。驗證OpenAPI是否符合REST設計最佳實踐

例如Zalando已經在這些準則所定義的REST設計一個公開的指導方針在我看來有可自動檢查基礎上,OpenAPI的規格很多規則:

  • 「不要向後打破兼容性「可以在不同版本的OpenAPI 文件進行比較時進行檢查。
  • 「總是返回JSON對象爲頂級數據結構以支持 擴展」
  • ‘保持網址動詞 - 免費’可能可能的,如果有 詞典相比,檢查。
  • ...

到目前爲止,我只找到檢查OpenAPI文檔的完整性和命名約定的工具。是否有人知道具有更高級規則的工具?

UPDATE:

同時我找到了一個名爲Zally的工具(https://github.com/zalando-incubator/zally)。該工具檢查是否違反了Zalando的REST-Api準則。配置或擴展相當容易。

回答

0

其中一些可作爲規則添加到openapilint。向後兼容性檢查需要比較兩個spec版本來尋找差異,這有點複雜。