Package 'rapidoc'

rapidoc: Generates RapiDoc documentation from an OpenAPI Specification

Description

RapiDoc is a collection of HTML, JavaScript, CSS and fonts assets that generate RapiDoc documentation from an OpenAPI Specification.

Details

The main purpose of this package is to enable package authors to create APIs that are compatible with https://mrin9.github.io/RapiDoc/ and https://www.openapis.org/.

To learn more about RapiDoc visit: https://mrin9.github.io/RapiDoc/

Author(s)

Maintainer: Bruno Tremblay [email protected]

Other contributors:

• Barret Schloerke [email protected] (ORCID) [contributor]

• Mrinmoy Majumdar [email protected] [copyright holder]

See Also

Useful links:

• https://github.com/meztez/rapidoc

• Report bugs at https://github.com/meztez/rapidoc/issues

---

Path to Rapidoc Index

Description

Retrieves the path to the rapidoc index file.

Usage

rapidoc_index()

Examples

## Not run: 
if (interactive()) {
  browseURL(rapidoc_index())
} else {
  print(paste("You can use rapidoc under: ", rapidoc_index()))
}

## End(Not run)

---

Path to RapiDoc Resources

Description

Retrieves the path to rapidoc resources.

Usage

rapidoc_path()

Examples

## Not run: 
if (interactive()) {
  browseURL(rapidoc_path())
} else {
  print(paste("You can explore rapidoc resources under: ", rapidoc_path()))
}

## End(Not run)

---

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)

---