inst/tinytest/test-parse-dosctring.R

In rexyai/RestRserve: A Framework for Building HTTP API

# Test openapi parser

# import functions

extract_docstrings_yaml = RestRserve:::extract_docstrings_yaml

# test extract_docstrings_yaml function
fn = function(req, res) {
  #' ---
  #' description: Calculates Fibonacci number
  #' parameters:
  #'   - name: "n"
  #'     description: "x for Fibonnacci number"
  #'     in: query
  #'     schema:
  #'       type: integer
  #'     example: 10
  #'     required: true
  #' responses:
  #'   200:
  #'     description: API response
  #'     content:
  #'       text/plain:
  #'         schema:
  #'           type: string
  #'           example: 5
  #' ---
}
docstring_args = extract_docstrings_yaml(fn)
expect_equal(length(docstring_args), 17L)
expect_equal(docstring_args[[1]], "description: Calculates Fibonacci number")
expect_equal(docstring_args[[17]], "          example: 5")
# should only work with functions
expect_error(parse_docstring(1))