Servactory Web provides a beautiful web interface for exploring and visualizing your Servactory services in Rails applications. It allows you to:

• Browse all services in your application in a hierarchical tree view
• View detailed information about each service, including inputs, internals, and outputs
• Examine the source code of each service
• Understand the structure and implementation of your services at a glance

This UI makes it easier to understand, debug, and document your Servactory services, especially in large applications with many services.

Add this line to your application's Gemfile:

gem "servactory-web"

And then execute:

bundle install

Mount the Servactory Web engine in your Rails application's routes:

# config/routes.rb
Rails.application.routes.draw do
  mount Servactory::Web::Engine => "/servactory" unless Rails.env.production?
end

For security reasons, this engine should not be used in production environments.

Create an initializer to configure Servactory Web:

# config/initializers/servactory_web.rb
Servactory::Web.configure do |config|
  # The name of your application (optional)
  config.app_name = "My Application"

  # The URL of your application (optional)
  config.app_url = "https://myapp.example.com"

  # The directory where your services are located (default: "app/services")
  config.app_services_directory = "app/services"
end

After installation and configuration, navigate to /servactory in your browser to access the Servactory Web interface.

The main page displays a hierarchical tree of all services in your application, organized by namespace. Click on any service to view its details.

The service details page provides comprehensive information about a specific service:

• Inputs: All input attributes with their types, validations, and other options
• Internals: All internal attributes with their types and options
• Outputs: All output attributes with their types and options
• Actions: All actions defined in the service with their options
• Source Code: The complete implementation of the service

This view makes it easy to understand what a service does, what it requires, and what it produces, without having to navigate through multiple files.

For a service defined like this:

class Users::CreateService < ApplicationService::Base
  input :email, type: String
  input :password, type: String
  input :name, type: String, required: false
  
  output :user, type: User
  output :token, type: String

  make :create_user!
  make :generate_token!

  private

  def create_user!
    outputs.user = User.create!(
      email: inputs.email,
      password: inputs.password,
      name: inputs.name
    )
  end

  def generate_token!
    outputs.token = TokenGeneratorService.call!(user: outputs.user)
  end
end

Servactory Web will display a detailed view showing all inputs, internals, outputs, and the source code, making it easy to understand the service's functionality at a glance.

This project is intended to be a safe, welcoming space for collaboration. Contributors are expected to adhere to the Contributor Covenant code of conduct. We recommend reading the contributing guide as well.

Featury is available as open source under the terms of the MIT License.