Skip to content

Validate OpenAPI Spec

Source: R/validate_api_spec.R
validate_api_spec.Rd

Validate an OpenAPI Spec using Swagger CLI which calls Swagger Parser.

Usage

validate_api_spec(pr, verbose = TRUE)

Arguments

pr

A Plumber API

verbose

Logical that determines if a "is valid" statement is displayed. Defaults to TRUE

Details

If the api is deemed invalid, an error will be thrown.

This function is VERY [Experimental] and may be altered, changed, or removed in the future.

Examples

if (FALSE) { # \dontrun{
pr <- plumb_api("plumber", "01-append")
validate_api_spec(pr)
} # }