rapidoc_spec: RapiDoc Index File with OpenAPI Path

In rapidoc: Generates 'RapiDoc' Documentation from an 'OpenAPI' Specification

RapiDoc Index File with OpenAPI Path

Description

Produces the content for a index.html file that will attempt to access a provided OpenAPI Specification URL.

Usage

rapidoc_spec(
  spec_url = "https://petstore.swagger.io/v2/swagger.json",
  fonts_css = "./fonts.css",
  slots = character(),
  ...
)

Arguments

spec_url	Url to an OpenAPI specification
fonts_css	Path to the fonts css file if you want to use fonts other than the default one.
slots	HTML content to include between '<rapi-doc>' and '</rapi-doc>'
...	Other options recognized by RapiDoc inside the 'rapi-doc' tag. You can replace '-' by underscore in names. See https://mrin9.github.io/RapiDoc/api.html for a list of available options.

Value

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

Examples

## Not run: 
if (interactive()) {
  slot1 <- '
  <img slot="logo"
  src="https://upload.wikimedia.org/wikipedia/commons/5/53/Google_%22G%22_Logo.svg"
  width=36px/>'
  rapidoc_spec("https://petstore.swagger.io/v2/swagger.json",
               fonts_css = "./fonts.css",
               slots = c(slot1),
               heading_text = "Google",
               allow_server_selection = FALSE)
}

## End(Not run)

rapidoc documentation built on Nov. 18, 2023, 1:07 a.m.