Skip to content

Endpoint

This page assumes you have been through the Create an Empty Application, and have a West Connectivity account & blank solution.

To test and understand the Event triggering mechanism we will use the native the Solution management page endpoint editor.


First Endpoint

Navigate to the Endpoints tab and create a new Http Endpoint. Select the GET method and give it a path (Eg. /test).

Endpoints are managed by the Webservice Micro-Service and triggered by the request event when an incoming Http request arrives to the public API. A routing layer is done for you to link the event to the different endpoints.

Select your new endpoint. You will see the script editor. Type the following Lua script to return the requests content.

return request

request is here provided by the endpoint routing. Learn more here.

Click Save or use CTRL + s keyboard key.


Test with the API documentation page

On the top left of the solution you will see a document icon:

API doc Icon

Click on it, and it will get to the automatically generated documentation page for your API with your first endpoint.

Notice the TRY button, click on it to call your first endpoint.

You will get a 200 response with the complete request content.


Interact with a service

All micro-services enabled in the Solution are available from scripting using the capitalized service alias. A few Core Services are always available however you might need to add the service to your solution to get it available.

Read more about service calls on the scripting reference.

Let's use now the native Config Service 'listservices' operation to list all services already enabled.

GET /test

return Config.listServices()

Try your endpoint again to get the result.

Now feel free to try any of the native services feature as documented.