Create new Controllers #
The Kuzzle API is composed of actions grouped in controllers.
A controller is a logical container that groups several actions together.
Each action receives a KuzzleRequest object argument, and is in charge of returning a result which will be transmitted in the response.
Register a new Controller #
We are going to modify the app.ts file to register a controller to expose new API actions.
For this, we need to use the Backend.controller.register method.
You can also declare Controller class for a better code organization.
This method takes the controller name and a ControllerDefinition which defines the controller actions:
app.controller.register('greeting', {
actions: {
sayHello: {
handler: async request => {
return `Hello, ${request.getString('name')}`
}
}
}
});
The code above will register a greeting controller with a sayHello action.
We defined a handler function that uses the name argument from the request and returns a Promise resolving to a string.
Kuzzle will generate a default HTTP route of the following format if none is provided:
GET /_/<controller-name>/<action-name>
Controller names and action names are converted to kebab-case in auto-generated URLs.
See our in-depth guide to learn how to declare your own HTTP routes
We can now test our new action:
:::: tabs ::: tab Kourou
kourou greeting:sayHello --arg name=Melis
[ℹ] Unknown command "greeting:sayHello", fallback to API method
🚀 Kourou - Executes an API query.
[ℹ] Connecting to http://localhost:7512 ...
"Hello, Melis"
[✔] Successfully executed "greeting:sayHello"
::: ::: tab HTTP
curl "http://localhost:7512/_/greeting/say-hello?name=Melis&pretty"
{
"requestId": "383e016a-447e-4138-aa53-c07c9fd5c923",
"status": 200,
"error": null,
"controller": "greeting",
"action": "sayHello",
"collection": null,
"index": null,
"volatile": null,
"result": "Hello, Melis"
}
::: ::: tab WebSocket
npx wscat -c ws://localhost:7512 --execute '{
"controller": "greeting",
"action": "sayHello",
"name": "Melis"
}'
{
"requestId": "a6f4f5b6-1aa2-4cf9-9724-12b12575c047",
"status": 200,
"error": null,
"controller": "greeting",
"action": "sayHello",
"collection": null,
"index": null,
"volatile": null,
"result": "Hello, Melis",
"room": "a6f4f5b6-1aa2-4cf9-9724-12b12575c047"
}
::: ::::