Module: Endpoints::TestApi

Defined in:
app/models/concerns/endpoints/test_api.rb

Class Method Summary collapse

Class Method Details

.test(params) ⇒ Object 



2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
 
# File 'app/models/concerns/endpoints/test_api.rb', line 2

def self.test params
    # Define an explain var to be used to validate and document the action behavior when using ?explain=true in query string
    explain = {
        verbs: ["GET"],
        body: {},
        query: {},
        responses: {
            200 => {
                message: :string,
                params: {}
            },
            501 => {
                error: :string
            }
        }
    }

    return explain, 200 if params[:explain] == "true"
    return { error: "This method responds only to #{explain[:verbs].join(", ")} requests" }, 501 if explain[:verbs].exclude? params[:request_verb]
    return { message: "Hello World From Test API Custom Action called test", params: params }, 200
end