Endpoints are the communication channels to access the services provided in your application snapshots. In Altogic, you create endpoints to expose your application services to the outside world.
To test an endpoint via the Tester, you need to navigate the Tester.
Step #1 - Select the endpoint that you would like to test
From the left panel of the Tester, please select the endpoint that you would like to test.
If the selected endpoint does not have a routed service, you will receive a warning message stating that you cannot test the selected endpoint. Endpoints should have a valid routed service so that you can test them.
Step #2 - Specify the required input parameters
At this step, you need to provide the input parameters of your endpoint, which is basically a RESTFul API endpoint. Then, depending on the requirements of the selected endpoint's service, provide inputs for the following items:
- Endpoint path parameters - Provide the required path parameters if the endpoint's path requires some ids to be provided (e.g., variables in curly brackets).
- Query parameters - Name value pairs that are concatenated to the URL path of the endpoint.
- Request headers - You need to at least provide a valid API key for the Authorization header. If required, you might also need to provide additional header data such as Session token.
- Request body - If required, specify the main body of the request, which is a JSON document.
- Files - If your endpoint service requires uploading files to the cloud storage, provide named file entries in this section.
Please refer to customizing start nodes to learn more about setting up input parameters for endpoint services in Altogic.
In the example below for a Sign-up endpoint that registers a new user, we first set the Authorization header and then started filling in the required request body input.
Step #3 - Submit request and review response
After specifying the required input parameters, it is time to submit your request. Just tap/click on Send to submit your request. The results of your request are displayed in the Response section, which provides the following data:
- Response status - Either success (200 - OK) or error with the error code.
- Duration - Total duration of the request in milliseconds or seconds from the time you clicked/tapped on the submit button until the response is received.
- Response body - The body of the response returned from the endpoint service. This data is usually provided by the success or error response nodes of the service.
- Response headers - The response headers data displayed in this section includes standard and also Altogic specific headers.
- Service logs - Provides detailed information about the service's node executions, the execution duration, and input and output parameters of the nodes.
Service logs provide detailed information about node executions, execution sequence, duration, and input & output parameters. Reviewing this data can help you identify potential errors or performance bottlenecks in your service designs.
x-duration (excluding service load time) and x-validated-duration (including service load time) custom response headers provide data on the actual duration of the endpoint service, excluding network latencies. Basically, these headers provide information on how long your service's execution took, excluding the time spent on the network traffic.