swagger_spec: Swagger Index File with OpenAPI Path

View source: R/paths.R

swagger_specR Documentation

Swagger Index File with OpenAPI Path

Description

Produces the content for a index.html file that will attempt to access a provided API path.

Usage

swagger_spec(
  api_path = "\"http://petstore.swagger.io/v2/swagger.json\"",
  version = "5"
)

Arguments

api_path

Path to paste into the an OpenAPI specification file

version

Major version number to be used for Swagger UI. Currently version "3" is compatible with OpenAPI spec 2.0, 3.0.

Value

large string containing the contents of swagger_index() with the appropriate specification path changed to the api_path value.

Examples

if (interactive()) {
  swagger_spec("https://developer.uspto.gov/ibd-api/swagger.json")
}

swagger documentation built on June 22, 2024, 12:27 p.m.