Module: Msf::WebServices::ApiDocsServlet

Includes:
Swagger::Blocks
Defined in:
lib/msf/core/web_services/servlet/api_docs_servlet.rb

Class Method Summary collapse

Class Method Details

.get_api_docs ⇒ Object 



23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
 
# File 'lib/msf/core/web_services/servlet/api_docs_servlet.rb', line 23

def self.get_api_docs
  lambda {
    swaggered_classes = [
        Msf::WebServices::Documentation::Api::V1::RootApiDoc,
        Msf::WebServices::Documentation::Api::V1::AuthApiDoc,
        Msf::WebServices::Documentation::Api::V1::CredentialApiDoc,
        Msf::WebServices::Documentation::Api::V1::DbExportApiDoc,
        Msf::WebServices::Documentation::Api::V1::EventApiDoc,
        Msf::WebServices::Documentation::Api::V1::ExploitApiDoc,
        Msf::WebServices::Documentation::Api::V1::HostApiDoc,
        Msf::WebServices::Documentation::Api::V1::LoginApiDoc,
        Msf::WebServices::Documentation::Api::V1::LootApiDoc,
        Msf::WebServices::Documentation::Api::V1::ModuleSearchApiDoc,
        Msf::WebServices::Documentation::Api::V1::MsfApiDoc,
        Msf::WebServices::Documentation::Api::V1::NmapApiDoc,
        Msf::WebServices::Documentation::Api::V1::NoteApiDoc,
        Msf::WebServices::Documentation::Api::V1::PayloadApiDoc,
        Msf::WebServices::Documentation::Api::V1::ServiceApiDoc,
        Msf::WebServices::Documentation::Api::V1::SessionApiDoc,
        Msf::WebServices::Documentation::Api::V1::SessionEventApiDoc,
        Msf::WebServices::Documentation::Api::V1::UserApiDoc,
        Msf::WebServices::Documentation::Api::V1::VulnApiDoc,
        Msf::WebServices::Documentation::Api::V1::VulnAttemptApiDoc,
        Msf::WebServices::Documentation::Api::V1::WorkspaceApiDoc
    ].freeze
    json = Swagger::Blocks.build_root_json(swaggered_classes)
    set_json_response(json, [])
  }
end

.html_path ⇒ Object 



10
11
12
 
# File 'lib/msf/core/web_services/servlet/api_docs_servlet.rb', line 10

def self.html_path
  '/api/v1/api-docs'
end

.json_path ⇒ Object 



6
7
8
 
# File 'lib/msf/core/web_services/servlet/api_docs_servlet.rb', line 6

def self.json_path
  '/api/v1/api-docs.json'
end

.registered(app) ⇒ Object 



14
15
16
17
18
19
 
# File 'lib/msf/core/web_services/servlet/api_docs_servlet.rb', line 14

def self.registered(app)
  app.get Msf::WebServices::ApiDocsServlet.json_path, &get_api_docs
  app.get Msf::WebServices::ApiDocsServlet.html_path do
    erb :api_docs
  end
end