integrate rswag and swagger-ui-react (wip)

Author: relf

.rspec

@@ -0,0 +1 @@
+--require spec_helper

Gemfile

@@ -129,4 +129,3 @@ gem "image_processing", "~> 1.2"
 
 # Document API
 gem 'rswag-api'
-gem 'rswag-ui'

app/assets/javascripts/application.js

@@ -7,5 +7,3 @@
 // = require x3dom
 // = require data-confirm-modal
 // = require_tree .
-
-

app/javascript/api_doc_viewer/index.jsx

@@ -22,7 +22,7 @@ class SwaggerApiDoc extends React.Component {
     return (
       <SwaggerUI
         ref={this.ref}
-        url={api.apiUrl('/api_doc')}
+        url={api.docUrl()}
         onComplete={this.preAuthorize}
       />
     );

app/javascript/utils/WhatsOptApi.js

@@ -45,6 +45,11 @@ class WhatsOptApi {
     return `${this.relativeUrlRoot}${API_URL}${path}`;
   }
 
+  // eslint-disable-next-line class-methods-use-this
+  docUrl() {
+    return '/api_doc/v1/swagger.yaml';
+  }
+
   openmdaoChecking(mdaId, callback) {
     const path = `/analyses/${mdaId}/openmdao_checking`;
     axios.post(this.apiUrl(path))

app/views/api_docs/show.html.erb

@@ -1,8 +1,8 @@
 <% if current_user %>
-  <div id="apidoc" data-api-key="<%=current_user.api_key%>"></div>
+<div id="apidoc" data-api-key="<%=current_user.api_key%>"></div>
 <% else %>
-  <div id="apidoc"></div> 
+<div id="apidoc"></div>
 <% end %>
+<div id="swagger-ui-config" data-swagger-ui-config="<%= @config_object.to_json %>"></div>>
 
-<%= javascript_pack_tag 'api_doc_viewer_application' %>
-
+<%= javascript_pack_tag 'api_doc_viewer_application' %>

config/initializers/rswag-ui.rb

@@ -1,7 +1,5 @@
 Rails.application.routes.draw do
 
-  mount Rswag::Ui::Engine => '/api-docs'
-  mount Rswag::Api::Engine => '/api-docs'
   devise_for :users
   resources :users, only: [:show]
   resource :api_doc, only: [:show]
@@ -49,4 +47,5 @@
   end
   root to: redirect('users/sign_in')
 
+  mount Rswag::Api::Engine => '/api_doc'
 end

config/routes.rb

@@ -28,7 +28,7 @@
     "react-promise-tracker": "^2.0.5",
     "react-table": "^7.0.0-rc.10",
     "save-svg-as-png": "^1.4.14",
-    "swagger-ui-react": "3.24.0",
+    "swagger-ui-react": "^3.25.0",
     "trix": "^1.0.0",
     "x3dom": "^1.7.2"
   },
@@ -53,4 +53,4 @@
     "lint": "yarn run eslint --ext .js --ext .jsx app/javascript",
     "lintfix": "yarn run eslint --fix --ext .js --ext .jsx app/javascript"
   }
-}
+}

package.json

@@ -0,0 +1,64 @@
+# This file is copied to spec/ when you run 'rails generate rspec:install'
+require 'spec_helper'
+ENV['RAILS_ENV'] ||= 'test'
+require File.expand_path('../config/environment', __dir__)
+# Prevent database truncation if the environment is production
+abort("The Rails environment is running in production mode!") if Rails.env.production?
+require 'rspec/rails'
+# Add additional requires below this line. Rails is not loaded until this point!
+
+# Requires supporting ruby files with custom matchers and macros, etc, in
+# spec/support/ and its subdirectories. Files matching `spec/**/*_spec.rb` are
+# run as spec files by default. This means that files in spec/support that end
+# in _spec.rb will both be required and run as specs, causing the specs to be
+# run twice. It is recommended that you do not name files matching this glob to
+# end with _spec.rb. You can configure this pattern with the --pattern
+# option on the command line or in ~/.rspec, .rspec or `.rspec-local`.
+#
+# The following line is provided for convenience purposes. It has the downside
+# of increasing the boot-up time by auto-requiring all files in the support
+# directory. Alternatively, in the individual `*_spec.rb` files, manually
+# require only the support files necessary.
+#
+# Dir[Rails.root.join('spec', 'support', '**', '*.rb')].sort.each { |f| require f }
+
+# Checks for pending migrations and applies them before tests are run.
+# If you are not using ActiveRecord, you can remove these lines.
+begin
+  ActiveRecord::Migration.maintain_test_schema!
+rescue ActiveRecord::PendingMigrationError => e
+  puts e.to_s.strip
+  exit 1
+end
+RSpec.configure do |config|
+  # Remove this line if you're not using ActiveRecord or ActiveRecord fixtures
+  config.fixture_path = "#{::Rails.root}/spec/fixtures"
+
+  # If you're not using ActiveRecord, or you'd prefer not to run each of your
+  # examples within a transaction, remove the following line or assign false
+  # instead of true.
+  config.use_transactional_fixtures = true
+
+  # You can uncomment this line to turn off ActiveRecord support entirely.
+  # config.use_active_record = false
+
+  # RSpec Rails can automatically mix in different behaviours to your tests
+  # based on their file location, for example enabling you to call `get` and
+  # `post` in specs under `spec/controllers`.
+  #
+  # You can disable this behaviour by removing the line below, and instead
+  # explicitly tag your specs with their type, e.g.:
+  #
+  #     RSpec.describe UsersController, type: :controller do
+  #       # ...
+  #     end
+  #
+  # The different available types are documented in the features, such as in
+  # https://relishapp.com/rspec/rspec-rails/docs
+  config.infer_spec_type_from_file_location!
+
+  # Filter lines from Rails gems in backtraces.
+  config.filter_rails_from_backtrace!
+  # arbitrary gems may also be filtered via:
+  # config.filter_gems_from_backtrace("gem name")
+end