Skip to content
Swagger is a collection of HTML, Javascript, and CSS assets that dynamically generate beautiful documentation from a Swagger-compliant API.
Branch: master
Clone or download
schloerke Add `swagger_spec()` and support major Swagger UI versions (#7)
Added download script to streamline updating the dist pkg
Currently only support version "3"
Latest commit 67239fd Jan 5, 2019
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
R use snake case for apiPath variable in swagger_spec Jan 4, 2019
inst update version to 3.20.4 Jan 4, 2019
man-roxygen use a major "version" parameter for all methods. Jan 4, 2019
man use snake case for apiPath variable in swagger_spec Jan 4, 2019
scripts update version to 3.20.4 Jan 4, 2019
tools/readme
.Rbuildignore add lintr file and ignore it Jan 4, 2019
.gitignore add a version to the dist folder Dec 18, 2018
.lintr add lintr file and ignore it Jan 4, 2019
.travis.yml added travis Jan 4, 2019
DESCRIPTION bump descript version to match swagger-ui version 3.20.4 Jan 4, 2019
LICENSE copy license file from swagger-ui repo Oct 25, 2017
NAMESPACE use a major "version" parameter for all methods. Jan 4, 2019
NEWS.md update news Feb 4, 2018
README.Rmd added travis Jan 4, 2019
README.md added travis Jan 4, 2019
swagger.Rproj add some basic usage examples Oct 25, 2017

README.md

Dynamically Generate Documentation from a 'Swagger' Compliant API

CRAN_Status_Badge Travis-CI 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

You can’t perform that action at this time.