https://github.com/typisttech/swagger_ui_standalone
Generate standalone static Swagger UI sites from OpenAPI specifications.
https://github.com/typisttech/swagger_ui_standalone
openapi static-site-generator swagger-ui
Last synced: 4 months ago
JSON representation
Generate standalone static Swagger UI sites from OpenAPI specifications.
- Host: GitHub
- URL: https://github.com/typisttech/swagger_ui_standalone
- Owner: typisttech
- License: mit
- Created: 2025-05-18T02:48:12.000Z (9 months ago)
- Default Branch: main
- Last Pushed: 2025-10-08T21:57:37.000Z (4 months ago)
- Last Synced: 2025-10-09T22:58:08.788Z (4 months ago)
- Topics: openapi, static-site-generator, swagger-ui
- Language: Ruby
- Homepage:
- Size: 6.29 MB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# Swagger UI Standalone
[](https://badge.fury.io/rb/swagger_ui_standalone)
[](https://github.com/typisttech/swagger_ui_standalone/actions/workflows/main.yml)
[](https://github.com/typisttech/swagger_ui_standalone/blob/master/LICENSE.txt)
[](https://x.com/tangrufus)
[](https://bsky.app/profile/tangrufus.com)
[](https://github.com/sponsors/tangrufus)
[](https://typist.tech/contact/)
Generate standalone static Swagger UI sites from OpenAPI specifications.
Built with ♥ by Typist Tech
---
## Quick Start
```bash
# Install the gem
gem install swagger_ui_standalone
# Prepare some custom files
mkdir custom
## Download some OpenAPI specifications
wget https://raw.githubusercontent.com/github/rest-api-description/refs/heads/main/descriptions/api.github.com/api.github.com.yaml -O custom/github.yaml
wget https://validator.swagger.io/validator/openapi.json -O custom/validator.yaml
## Make a disallow all robots.txt file
cat > custom/robots.txt < custom/swagger-initializer.js <
# Default: swagger-api/swagger-ui
[--ref=TAG|BRANCH|SHA] # Git reference to download (can be a tag, branch or commit SHA). Omit to use the latest release
[--force] # Overwrite files that already exist
Generate standalone static Swagger UI
```
### `download`
```console
$ swagger_ui_standalone help download
Usage:
swagger_ui_standalone download [options] --output=DIRECTORY
Options:
--output=DIRECTORY # Where to write the generated files
[--repo=OWNER/REPO] # GitHub repository to download in the format
# Default: swagger-api/swagger-ui
[--ref=TAG|BRANCH|SHA] # Git reference to download (can be a tag, branch or commit SHA). Omit to use the latest release
[--force] # Overwrite files that already exist
Download standalone static Swagger UI source code
```
## Installation
Install the gem and add to the application's Gemfile by executing:
```bash
bundle add swagger_ui_standalone
```
If bundler is not being used to manage dependencies, install the gem by executing:
```bash
gem install swagger_ui_standalone
```
## Credits
[`Swagger UI Standalone`](https://github.com/typisttech/swagger_ui_standalone) is a [Typist Tech](https://typist.tech) project and
maintained by [Tang Rufus](https://x.com/TangRufus), freelance developer [for hire](https://typist.tech/contact/).
Full list of contributors can be found [on GitHub](https://github.com/typisttech/swagger_ui_standalone/graphs/contributors).
## Copyright and License
This project is a [free software](https://www.gnu.org/philosophy/free-sw.en.html) distributed under the terms of
the MIT license. For the full license, see [LICENSE](./LICENSE.txt).
## Contribute
Feedbacks / bug reports / pull requests are welcome.