rstudio/plumber

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

Open

#817 创建于 2021年8月9日

在 GitHub 查看
 (0 评论) (1 反应) (0 负责人)R (1,437 star) (257 fork)batch import
difficulty: intermediateeffort: lowhelp wantedpriority: mediumtheme: OpenAPI

描述

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.

贡献者指南

技术栈
nodejs
领域
apibackend
议题类型
feature
难度面向新贡献者的预计实现难度，1 表示很小改动，5 表示专家级工作。
3
预计时间有经验贡献者完成调查、实现、测试并准备 pull request 的粗略时间范围。
1-3 hours
活动状态议题当前的可参与程度：新鲜、活跃、陈旧、阻塞或等待维护者输入。
stale
清晰度议题是否清楚说明期望改动、验收标准和下一步。
mostly clear
前置要求
Familiarity with R package structureUnderstanding of OpenAPI spec validationKnowledge of plumber's validate api spec function
新手友好度1-100 的估计分数，表示该议题对首次贡献者的友好程度。
40
研究方向
Investigate the current use of swagger validator in plumber's codebase, likely in the validation module. Review the openapi schema validator package documentation and API. Implement the replacement in the validate api spec function. Ensure OAS v3 support is added. Test with both OAS v2 and v3 specifications.