IAPIDeclaration
in
Declaration for a Group of API Functions
Table of Contents
Methods
- apiVersion() : string
- This function is returning the version of the API endpoint that the request is being made to. (/v<VERSION>/<NAME>)
- contentType() : string
- This function is defining the content type that the request body should be in.
- getMethods() : array<string|int, mixed>
- This function is defining the available methods or endpoints within the API
- id() : string
- This function is returning the name of the API endpoint that the request is being made to. (/v<VERSION>/<NAME>)
- isAuthorizationRequired() : bool
- This function is checking whether the API endpoint requires authorization or not.
Methods
apiVersion()
This function is returning the version of the API endpoint that the request is being made to. (/v<VERSION>/<NAME>)
public
apiVersion() : string
Return values
stringcontentType()
This function is defining the content type that the request body should be in.
public
contentType() : string
Return values
stringgetMethods()
This function is defining the available methods or endpoints within the API
public
getMethods() : array<string|int, mixed>
Return values
array<string|int, mixed>id()
This function is returning the name of the API endpoint that the request is being made to. (/v<VERSION>/<NAME>)
public
id() : string
Return values
stringisAuthorizationRequired()
This function is checking whether the API endpoint requires authorization or not.
public
isAuthorizationRequired() : bool