https://github.com/rstudio/swagger

Swagger is a collection of HTML, Javascript, and CSS assets that dynamically generate beautiful documentation from a Swagger-compliant API.
https://github.com/rstudio/swagger

Last synced: about 1 month ago
JSON representation

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

• Host: GitHub
• URL: https://github.com/rstudio/swagger
• Owner: rstudio
• License: other
• Created: 2017-10-25T21:02:12.000Z (about 7 years ago)
• Default Branch: main
• Last Pushed: 2024-06-29T17:15:22.000Z (6 months ago)
• Last Synced: 2024-09-16T14:09:34.386Z (3 months ago)
• Language: HTML
• Homepage: https://swagger.io/swagger-ui/
• Size: 6.98 MB
• Stars: 53
• Watchers: 10
• Forks: 12
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• jimsghstars - rstudio/swagger - Swagger is a collection of HTML, Javascript, and CSS assets that dynamically generate beautiful documentation from a Swagger-compliant API. (HTML)

README

        
Dynamically Generate Documentation from a 'Swagger' Compliant API

================

[![CRAN\_Status\_Badge](https://www.r-pkg.org/badges/version/swagger)](https://cran.r-project.org/package=swagger)

[![R build status](https://github.com/rstudio/swagger/actions/workflows/R-CMD-check.yaml/badge.svg)](https://github.com/rstudio/swagger/actions)

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](https://swagger.io/) and [openapis.org](https://www.openapis.org/).

Package authors providing web interfaces can serve the static files from `swagger_path()` using [httpuv](https://github.com/rstudio/httpuv) or [fiery](https://github.com/thomasp85/fiery). As a start, we can also browse them by running:

``` r

library(swagger)

browseURL(swagger_index())

```



To learn more about Swagger visit: [swagger.io/swagger-ui](https://swagger.io/swagger-ui/)