This insert is unique to API service modules and should not be used anywhere else. Therefore, other than enhancements and bug fixes to the SRP HTTP Framework, this insert should be left alone.
In addition to providing declarations for several utility service modules, the API_Setup
is responsible for setting up these important variables:
Variables | Description |
---|---|
APIURL | The base URL for the API entry point (e.g., api.mysite.com/v1). |
FullEndPointURL | The URL submitted by the client. |
FullEndPointURLNoQuery | The URL submitted by the client stripped of any query params. |
HTTPMethod | The HTTP Method (Verb) submitted by the client (e.g., GET, POST, etc.) |
EndpointSegment | The URL segment representing the current resource. |
ParentSegment | The URL segment representing the parent resource to the current resource. |
CurrentAPI | The name of the currently running BASIC+ stored procedure. |