integrate rapidoc

Author: thomasp85

R/Plumber.R

@@ -40,8 +40,8 @@ Plumber <- R6Class(
     #' @param host A string overriding the default host
     #' @param port An port number overriding the default port
     #' @param doc_type The type of API documentation to generate. Can be either
-    #' `"redoc"` (the default), `"swagger"`, or `NULL` (equating to not
-    #' generating API docs)
+    #' `"rapidoc"` (the default), `"redoc"`, `"swagger"`, or `NULL` (equating to
+    #' not generating API docs)
     #' @param doc_path The URL path to serve the api documentation from
     #' @param reject_missing_methods Should requests to paths that doesn't
     #' have a handler for the specific method automatically be rejected with a
@@ -85,7 +85,7 @@ Plumber <- R6Class(
       super$initialize(host, port)
 
       if (!is.null(doc_type)) {
-        private$DOC_TYPE <- arg_match0(doc_type, c("swagger", "redoc"))
+        private$DOC_TYPE <- arg_match0(doc_type, c("rapidoc", "redoc", "swagger"))
       }
       check_string(doc_path)
       private$DOC_PATH <- doc_path
@@ -384,12 +384,12 @@ Plumber <- R6Class(
       private$HEADER_ROUTER
     },
     #' @field doc_type The type of API documentation to generate. Can be either
-    #' `"redoc"` (the default), `"swagger"`, or `NULL` (equating to not
-    #' generating API docs)
+    #' `"rapidoc"` (the default), `"redoc"`, `"swagger"`, or `NULL` (equating to
+    #' not generating API docs)
     doc_type = function(value) {
       if (missing(value)) return(private$DOC_TYPE)
       if (!is.null(value)) {
-        value <- arg_match0(value, c("swagger", "redoc"))
+        value <- arg_match0(value, c("rapidoc", "redoc", "swagger"))
       }
       private$DOC_TYPE <- value
     },

R/api.R

@@ -12,7 +12,7 @@
 #' listened on. Note that on most Unix-like systems including Linux and macOS,
 #' port numbers smaller than 1024 require root privileges.
 #' @param doc_type The type of API documentation to generate. Can be either
-#' `"redoc"` (the default), `"swagger"`, or `NULL` (equating to not
+#' `"rapidoc"` (the default), `"redoc"`, `"swagger"`, or `NULL` (equating to not
 #' generating API docs)
 #' @param doc_path The URL path to serve the api documentation from
 #' @param reject_missing_methods Should requests to paths that doesn't
@@ -53,7 +53,7 @@ api <- function(
   ...,
   host = get_opts("host", "127.0.0.1"),
   port = get_opts("port", 8080),
-  doc_type = get_opts("docs", "redoc"),
+  doc_type = get_opts("docs", "rapidoc"),
   doc_path = get_opts("apiPath", "__docs__"),
   reject_missing_methods = get_opts("methodNotAllowed", FALSE),
   ignore_trailing_slash = get_opts("trailingSlash"),

R/api_docs.R

@@ -3,13 +3,13 @@
 #' The [OpenAPI standard](https://www.openapis.org) offers a way to describe the
 #' various endpoints of your api in machine- and human-readable way. On top of
 #' this, various solutions have been build to generate online documentation of
-#' the API based on a provided OpenAPI spec. plumber2 offers both support for
-#' [Redoc](https://redocly.com/redoc) or [Swagger](https://swagger.io) as a UI
-#' frontend for the documentation and will also generate the spec for you based
-#' on the tags in parsed files. If you are creating your API programmatically
-#' or you wish to add to the autogenerated docs you can add docs manually,
-#' either when adding a handler (using the `doc` argument), or with the
-#' `api_doc_add()` function
+#' the API based on a provided OpenAPI spec. plumber2 offers support for
+#' [RapiDoc](https://rapidocweb.com), [Redoc](https://redocly.com/redoc), and
+#' [Swagger](https://swagger.io) as a UI frontend for the documentation and will
+#' also generate the spec for you based on the tags in parsed files. If you are
+#' creating your API programmatically or you wish to add to the autogenerated
+#' docs you can add docs manually, either when adding a handler (using the `doc`
+#' argument), or with the `api_doc_add()` function
 #'
 #' @param api A plumber2 api object to add docs or doc settings to
 #' @inheritParams api