Skip to contents

Starts a plumber API server that serves pre-computed JSON files from docs/api/v1/. Requires the plumber package.

Usage

run_api(port = 8080, host = "0.0.0.0")

Arguments

port

Integer port number (default: 8080)

host

Character host address (default: "0.0.0.0")

Value

Invisibly returns the plumber router (runs until interrupted).

Examples

if (FALSE) { # \dontrun{
run_api()
# API available at http://localhost:8080
# Swagger docs at http://localhost:8080/__docs__/
} # }