Skip to content

Swagger is a collection of HTML, Javascript, and CSS assets that dynamically generate beautiful documentation from a Swagger-compliant API.

License

Notifications You must be signed in to change notification settings

rstudio/swagger

Repository files navigation

Dynamically Generate Documentation from a 'Swagger' Compliant API

CRAN_Status_Badge R build status

Swagger is a collection of HTML, JavaScript, and CSS assets that dynamically generate beautiful documentation from a Swagger-compliant API.

The main purpose of this package is to enable package authors to create APIs that are compatible with swagger.io and openapis.org.

Package authors providing web interfaces can serve the static files from swagger_path() using httpuv or fiery. As a start, we can also browse them by running:

library(swagger)
browseURL(swagger_index())

To learn more about Swagger visit: swagger.io/swagger-ui

About

Swagger is a collection of HTML, Javascript, and CSS assets that dynamically generate beautiful documentation from a Swagger-compliant API.

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Contributors 4

  •  
  •  
  •  
  •