Merge pull request #2 from SiloGecho97/add-openapi-ui

feat: Add OpenAPI UI using scalar

Author: SiloGecho97

Gemfile

@@ -35,6 +35,7 @@ gem "thruster", require: false
 # Use Rack CORS for handling Cross-Origin Resource Sharing (CORS), making cross-origin Ajax possible
 # gem "rack-cors"
 gem "committee"
+gem "scalar_ruby", "~> 1.1"
 
 group :development, :test do
   # See https://guides.rubyonrails.org/debugging_rails_applications.html#debugging-with-the-debug-gem

Gemfile.lock

@@ -249,6 +249,7 @@ GEM
       rubocop-performance (>= 1.24)
       rubocop-rails (>= 2.30)
     ruby-progressbar (1.13.0)
+    scalar_ruby (1.1.0)
     securerandom (0.4.1)
     solid_cable (3.0.7)
       actioncable (>= 7.2)
@@ -309,6 +310,7 @@ DEPENDENCIES
   puma (>= 5.0)
   rails (~> 8.0.2)
   rubocop-rails-omakase
+  scalar_ruby (~> 1.1)
   solid_cable
   solid_cache
   solid_queue

config/initializers/scalar.rb

@@ -0,0 +1,5 @@
+# config/initializers/scalar.rb
+
+Scalar.setup do |config|
+  config.specification = File.read(Rails.root.join("docs/openapi.json"))
+end

config/routes.rb

@@ -1,4 +1,5 @@
 Rails.application.routes.draw do
+  mount Scalar::UI, at: "/docs"
   resources :comments
   # Define your application routes per the DSL in https://guides.rubyonrails.org/routing.html