oas_rails
Generate Automatic Interactive Documentation for Your Rails API
File Explorer
Download Latest Version (.zip)- release_please.yml
- rubyonrails.yml
- oas_rails_manifest.js
- .keep
- application.css
- .keep
- application_controller.rb
- oas_rails_controller.rb
- application_helper.rb
- oas_rails_helper.rb
- test_helper.rb
- application.html.erb
- _rapidoc_style_parts.html.erb
- index.html.erb
- show.html.erb
- rails
- routes.rb
- rails-7.1.gemfile
- rails-7.2.gemfile
- rails-8.0.0.gemfile
- oas_rails_initializer.rb
- config_generator.rb
- esquema_builder.rb
- oas_route_builder.rb
- render_response_extractor.rb
- route_extractor.rb
- active_record_example_finder.rb
- configuration.rb
- engine.rb
- utils.rb
- version.rb
- oas_rails.rb
- rapidoc-min.js
- oas_rails_controller_test.rb
- .keep
- manifest.js
- .keep
- application.css
- channel.rb
- connection.rb
- reports_controller.rb
- .keep
- avatar_controller.rb
- application_controller.rb
- comments_controller.rb
- posts_controller.rb
- projects_controller.rb
- typed_controller.rb
- users_controller.rb
- application_helper.rb
- users_helper.rb
- application_job.rb
- application_mailer.rb
- .keep
- application_record.rb
- comment.rb
- post.rb
- project.rb
- user.rb
- application.html.erb
- mailer.html.erb
- mailer.text.erb
- rails
- rake
- setup
- development.rb
- production.rb
- test.rb
- assets.rb
- content_security_policy.rb
- crs.rb
- filter_parameter_logging.rb
- inflections.rb
- oas_rails.rb
- permissions_policy.rb
- en.yml
- application.rb
- boot.rb
- cable.yml
- database.yml
- environment.rb
- puma.rb
- routes.rb
- storage.yml
- 20240712004600_create_users.rb
- 20240718211538_create_projects.rb
- 20250419163914_add_different_kind_of_variables_to_projects.rb
- 20250528212011_create_active_storage_tables.active_storage.rb
- 20260518202040_create_posts.rb
- 20260518202041_create_comments.rb
- schema.rb
- .keep
- json_web_token.rb
- oas.json
- .keep
- 404.html
- 422.html
- 500.html
- apple-touch-icon-precomposed.png
- apple-touch-icon.png
- favicon.ico
- reports_controller_test.rb
- avatar_controller_test.rb
- comments_controller_test.rb
- posts_controller_test.rb
- projects_controller_test.rb
- users_controller_test.rb
- comments.rb
- posts.rb
- projects.rb
- users.rb
- projects.yml
- users.yml
- comment_test.rb
- post_test.rb
- project_test.rb
- user_test.rb
- users_test.rb
- config.ru
- Rakefile
- README.md
- README_OAS.md
- .keep
- avatar.jpg
- plain_text.txt
- .keep
- auth_helper.rb
- .keep
- navigation_test.rb
- esquema_builder_test.rb
- oas_route_builder_test.rb
- route_extractor_test.rb
- active_record_example_finder_test.rb
- configuration_test.rb
- utils_test.rb
- .keep
- .keep
- oas_rails_test.rb
- test_helper.rb
- .gitignore
- .release-please-config.json
- .release-please-manifest.json
- .rubocop.yml
- .rubocop_todo.yml
- .ruby-version
- CHANGELOG.md
- Gemfile
- Gemfile.lock
- LICENSE
- oas_rails.gemspec
- Rakefile
- README.md
# Installation Guide
1. Get the code
git clone https://github.com/a-chacon/oas_rails
Downloads the entire project code from GitHub to your computer.
cd oas_rails
Moves into the project folder you just downloaded.
2. Ruby
Easy RecommendedPrerequisites
bundle install
Installs the Ruby libraries listed in the Gemfile.
If bundle install finishes without errors, continue with the run command from the README (e.g. rails server).
// repository documentation
Was this content helpful?
(0 ratings)