rswag
Seamlessly adds a Swagger to Rails-based API's
File Explorer
Download Latest Version (.zip)- bug_report.md
- config.yml
- feature_request.md
- deploy-rswag.yml
- rubocop.yml
- ruby.yml
- spellcheck.yml
- dependabot.yml
- pull_request_template.md
- stale.yml
- build.sh
- test.sh
- install_generator.rb
- USAGE
- railtie.rb
- rswag.rb
- routes.rb
- .gitkeep
- install_generator_spec.rb
- MIT-LICENSE
- rswag.gemspec
- rails
- rswag_api.rb
- install_generator.rb
- USAGE
- configuration.rb
- engine.rb
- middleware.rb
- api.rb
- .gitkeep
- routes.rb
- install_generator_spec.rb
- configuration_spec.rb
- api_spec.rb
- routes.rb
- openapi.json
- openapi.yml
- middleware_spec.rb
- spec_helper.rb
- .rspec
- MIT-LICENSE
- Rakefile
- rswag-api.gemspec
- spec.rb.erb
- openapi_generator.rb
- USAGE
- openapi_helper.rb
- install_generator.rb
- USAGE
- configuration.rb
- example_group_helpers.rb
- example_helpers.rb
- extended_schema.rb
- openapi_formatter.rb
- railtie.rb
- request_factory.rb
- response_validator.rb
- route_parser.rb
- specs.rb
- rswag-specs_tasks.rake
- .gitkeep
- openapi_generator_spec.rb
- .gitkeep
- install_generator_spec.rb
- configuration_spec.rb
- example_group_helpers_spec.rb
- example_helpers_spec.rb
- openapi_formatter_spec.rb
- request_factory_spec.rb
- response_validator_spec.rb
- route_parser_spec.rb
- specs_spec.rb
- openapi_helper.rb
- spec_helper.rb
- .rspec
- .rubocop_rspec_alias_config.yml
- MIT-LICENSE
- Rakefile
- rswag-specs.gemspec
- rails
- custom_generator.rb
- USAGE
- rswag_ui.rb
- install_generator.rb
- USAGE
- basic_auth.rb
- configuration.rb
- engine.rb
- index.erb
- middleware.rb
- ui.rb
- rswag-ui_tasks.rake
- .gitkeep
- routes.rb
- custom_generator_spec.rb
- install_generator_spec.rb
- configuration_spec.rb
- spec_helper.rb
- .rspec
- MIT-LICENSE
- package-lock.json
- package.json
- Rakefile
- rswag-ui.gemspec
- manifest.js
- .keep
- stubs.js
- stubs.css
- application_controller.rb
- auth_tests_controller.rb
- blogs_controller.rb
- stubs_controller.rb
- stubs_helper.rb
- .gitkeep
- blog.rb
- development.rb
- test.rb
- backtrace_silencers.rb
- inflections.rb
- mime_types.rb
- rswag-api.rb
- rswag-ui.rb
- secret_token.rb
- session_store.rb
- wrap_parameters.rb
- application.rb
- boot.rb
- database.yml
- environment.rb
- routes.rb
- 20160218212104_create_blogs.rb
- schema.rb
- openapi.json
- .gitkeep
- thumbnail.png
- 404.html
- 422.html
- 500.html
- favicon.ico
- rails
- openapi_ui_spec.rb
- thumbnail.png
- auth_tests_spec.rb
- blogs_spec.rb
- rswag_specs_swaggerize_spec.rb
- openapi_helper.rb
- rails_helper.rb
- spec_helper.rb
- .rspec
- config.ru
- Rakefile
- traverse-secret.yml
- .dockerignore
- .gitignore
- .rubocop.yml
- .rubocop_todo.yml
- CHANGELOG.md
- CONTRIBUTING.md
- cspell.json
- docker-compose.yml
- Dockerfile
- Gemfile
- Makefile
- MIT-LICENCE
- README.md
- SECURITY.md
π Installation Guide
1. Get the code
git clone https://github.com/rswag/rswag
Downloads the entire project code from GitHub to your computer.
cd rswag
Moves into the project folder you just downloaded.
2. Docker
Easy RecommendedPrerequisites
- Git Needed to download the project code from GitHub.
- Docker Desktop Needed to build and run containers. Install it and keep it running in the background.
docker pull swaggerapi/swagger-editor
Type this command into your terminal and run it.
docker run -d -p 80:8080 swaggerapi/swagger-editor
Runs the built image as an actual container.
Run docker compose ps to check the containers are Up. If the README mentions a port, open http://localhost:PORT in your browser.
Pulled directly from this repo's README.
3. Node.js
EasyPrerequisites
cd rswag-ui
This project's files live in a subfolder, so move into it first.
npm install
Downloads and installs the libraries listed in package.json.
npm start
Starts the development/run server.
After running the command, open the address shown in the terminal (usually something like http://localhost:3000) in your browser.
4. Ruby
EasyPrerequisites
bundle exec rake rswag:ui:copy_assets[public/api-docs]
Type this command into your terminal and run it.
If bundle install finishes without errors, continue with the run command from the README (e.g. rails server).
Pulled directly from this repo's README.
5. Make
MediumPrerequisites
- Git Needed to download the project code from GitHub.
- Make Usually pre-installed on Linux/macOS. On Windows, install separately (e.g. via MSYS2 or WSL).
make
Compiles the code based on the generated build configuration to produce an executable.
If it finishes without errors, it worked. Try running the generated executable directly.
// repository documentation
Was this content helpful?
(0 ratings)