rstudio/plumber

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

Open

#817 aperta il 9 ago 2021

Vedi su GitHub
 (0 commenti) (1 reazione) (0 assegnatari)R (257 fork)batch import
difficulty: intermediateeffort: lowhelp wantedpriority: mediumtheme: OpenAPI

Metriche repository

Star
 (1437 star)
Metriche merge PR
 (Nessuna PR mergiata in 30 g)

Descrizione

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.

Guida contributor

Direzione di ricerca
Indaga l'uso attuale di swagger validator nella codebase di plumber, probabilmente nel modulo di validazione. Rivedi la documentazione e l'API del pacchetto openapi schema validator. Implementa la sostituzione nella funzione validate api spec. Assicurati di aggiungere il supporto per OAS v3. Testa con le specifiche OAS v2 e v3.
Tech stack
javascriptnodejs
Dominio
api
Tipo issue
Refactoring
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
2
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
1-3 ore
Stato attivitàQuanto è probabile che la issue sia ancora attiva e reviewable.
Attiva
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
Chiara
Prerequisiti
Gitnpm
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
70