Class: Docit::Configuration

Inherits:
Object
  • Object
show all
Defined in:
lib/docit/configuration.rb

Overview

Holds global API documentation settings: metadata, authentication, tags, and servers.

Constant Summary collapse

SUPPORTED_UIS = 
%i[scalar swagger].freeze

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize ⇒ Configuration

Returns a new instance of Configuration.



12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
 
# File 'lib/docit/configuration.rb', line 12

def initialize
  @title = "API Documentation"
  @version = "1.0.0"
  @description = "Welcome to the API documentation. Browse the endpoints below to get started."
  @base_url = "/"
  @system_graph_enabled = true
  @system_graph_excluded_paths = []
  @default_ui = :scalar
  @security_schemes = {}
  @tags = []
  @servers = []
  @license = nil
  @contact = nil
  @terms_of_service = nil
end

Instance Attribute Details

#base_url ⇒ Object

Returns the value of attribute base_url.



8
9
10
 
# File 'lib/docit/configuration.rb', line 8

def base_url
  @base_url
end

#default_ui ⇒ Object

Returns the value of attribute default_ui.



10
11
12
 
# File 'lib/docit/configuration.rb', line 10

def default_ui
  @default_ui
end

#description ⇒ Object

Returns the value of attribute description.



8
9
10
 
# File 'lib/docit/configuration.rb', line 8

def description
  @description
end

#system_graph_enabled ⇒ Object

Returns the value of attribute system_graph_enabled.



8
9
10
 
# File 'lib/docit/configuration.rb', line 8

def system_graph_enabled
  @system_graph_enabled
end

#system_graph_excluded_paths ⇒ Object

Returns the value of attribute system_graph_excluded_paths.



8
9
10
 
# File 'lib/docit/configuration.rb', line 8

def system_graph_excluded_paths
  @system_graph_excluded_paths
end

#title ⇒ Object

Returns the value of attribute title.



8
9
10
 
# File 'lib/docit/configuration.rb', line 8

def title
  @title
end

#version ⇒ Object

Returns the value of attribute version.



8
9
10
 
# File 'lib/docit/configuration.rb', line 8

def version
  @version
end

Instance Method Details

#auth(type, **options) ⇒ Object 



35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
 
# File 'lib/docit/configuration.rb', line 35

def auth(type, **options)
  case type.to_s.downcase
  when "basic"
    @security_schemes[:basic_auth] = {
      type: "http",
      scheme: "basic"
    }
  when "bearer"
    @security_schemes[:bearer_auth] = {
      type: "http",
      scheme: "bearer",
      bearerFormat: options[:bearer_format] || "JWT"
    }
  when "api_key"
    @security_schemes[:api_key] = {
      type: "apiKey",
      name: options[:name] || "X-API-Key",
      in: options[:location] || "header"
    }
  else
    raise ArgumentError, "Unsupported auth type: #{type}"
  end
end

#contact(name: nil, email: nil, url: nil) ⇒ Object 



93
94
95
96
97
98
99
 
# File 'lib/docit/configuration.rb', line 93

def contact(name: nil, email: nil, url: nil)
  entry = {}
  entry[:name] = name if name
  entry[:email] = email if email
  entry[:url] = url if url
  @contact = entry
end

#contact_info ⇒ Object 



101
102
103
 
# File 'lib/docit/configuration.rb', line 101

def contact_info
  @contact&.dup
end

#license(name:, url: nil) ⇒ Object 



83
84
85
86
87
 
# File 'lib/docit/configuration.rb', line 83

def license(name:, url: nil)
  entry = { name: name }
  entry[:url] = url if url
  @license = entry
end

#license_info ⇒ Object 



89
90
91
 
# File 'lib/docit/configuration.rb', line 89

def license_info
  @license&.dup
end

#security_schemes ⇒ Object 



59
60
61
 
# File 'lib/docit/configuration.rb', line 59

def security_schemes
  @security_schemes.dup
end

#server(url, description: nil) ⇒ Object 



73
74
75
76
77
 
# File 'lib/docit/configuration.rb', line 73

def server(url, description: nil)
  entry = { url: url.to_s }
  entry[:description] = description if description
  @servers << entry
end

#servers ⇒ Object 



79
80
81
 
# File 'lib/docit/configuration.rb', line 79

def servers
  @servers.dup
end

#tag(name, description: nil) ⇒ Object 



63
64
65
66
67
 
# File 'lib/docit/configuration.rb', line 63

def tag(name, description: nil)
  entry = { name: name.to_s }
  entry[:description] = description if description
  @tags << entry
end

#tags ⇒ Object 



69
70
71
 
# File 'lib/docit/configuration.rb', line 69

def tags
  @tags.dup
end

#terms_of_service(url) ⇒ Object 



105
106
107
 
# File 'lib/docit/configuration.rb', line 105

def terms_of_service(url)
  @terms_of_service = url
end

#terms_of_service_url ⇒ Object 



109
110
111
 
# File 'lib/docit/configuration.rb', line 109

def terms_of_service_url
  @terms_of_service
end