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