rstudio/plumber

Use `openapi-schema-validator` for `validate_api_spec()`

開放

#817 建立於 2021年8月9日

在 GitHub 查看貢獻者指南
 (0 則留言) (1 個反應) (0 位負責人)R (257 個分叉)batch import
difficulty: intermediateeffort: lowhelp wantedpriority: mediumtheme: OpenAPI

倉庫指標

星標
 (1,437 顆星)
PR 合併指標
 (30 天內沒有已合併 PR)

描述

Found while resolving #796

npmjs.com/package/openapi-schema-validator has added support for OAS v3. (Live) Example: runkit.com/embed/fitj6h1o17e8

Describe the problem in detail

swagger-parser does not validate OAS v3. https://github.com/APIDevTools/swagger-parser/issues/164#issuecomment-895261437 This is 😢 .

openapi-schema-validator does validate OAS v3 and has a quarter million downloads a week. Should work fine.

Plan, remove swagger-validator and use openapi-schema-validator instead.

貢獻者指南

研究方向
調查當前在 plumber 程式碼庫中 swagger validator 的使用情況，很可能在驗證模組中。查閱 openapi schema validator 套件的文件和 API。在 validate api spec 函式中實作替換。確保新增對 OAS v3 的支援。使用 OAS v2 和 v3 規範進行測試。
技術棧
javascriptnodejs
領域
api
議題類型
重構
難度面向新貢獻者的預計實作難度，1 表示很小改動，5 表示專家級工作。
2
預計時間有經驗貢獻者完成調查、實作、測試並準備 pull request 的粗略時間範圍。
1-3 小時
活動狀態議題目前的可參與程度：新鮮、活躍、陳舊、阻塞或等待維護者輸入。
活躍
清晰度議題是否清楚說明預期改動、驗收標準和下一步。
清晰
前置要求
Gitnpm
新手友善度1-100 的估計分數，表示該議題對首次貢獻者的友善程度。
70