The 'Hapi CLI' with a 'route add' command does not exist. Hapi is a Node.js framework for building applications and APIs, and routes are defined programmatically within your JavaScript application code, not through a command-line interface. To add a route in Hapi.js, you would typically use the `server.route()` method. Below is an example of how you define a route in a Hapi.js application:
**Example Hapi.js Route Definition:**
const Hapi = require('@hapi/hapi');
const init = async () => {
const server = Hapi.server({
port: 3000,
host: 'localhost'
});
// Define a GET route
server.route({
method: 'GET',
path: '/hello',
handler: (request, h) => {
return 'Hello, Hapi!';
}
});
// Define a POST route with payload access
server.route({
method: 'POST',
path: '/submit',
handler: (request, h) => {
const payload = request.payload;
return `Received: ${JSON.stringify(payload)}`;
}
});
// Define a route with path parameters
server.route({
method: 'GET',
path: '/user/{id}',
handler: (request, h) => {
return `User ID: ${request.params.id}`;
}
});
await server.start();
console.log(`Server running on ${server.info.uri}`);
};
process.on('unhandledRejection', (err) => {
console.log(err);
process.exit(1);
});
init();**Explanation:**
* **`const Hapi = require('@hapi/hapi');`**: Imports the Hapi framework.
* **`const server = Hapi.server({ ... });`**: Creates a new Hapi server instance, specifying port and host.
* **`server.route({ ... });`**: This is the core method for defining routes. It accepts an object (or an array of objects) with the following key properties:
* **`method`**: The HTTP method for the route (e.g., `'GET'`, `'POST'`, `'PUT'`, `'DELETE'`, `'*'` for any method).
* **`path`**: The URL path for the route. Path parameters can be defined using `{paramName}` syntax (e.g., `/user/{id}`). Wildcards (`/{param*}`) and optional segments (`/{param?}`) are also supported.
* **`handler`**: A function that will be executed when the route is matched. It receives two arguments: `request` (the incoming request object) and `h` (the response toolkit).
* The `request` object contains details about the incoming request, such as `request.params` (path parameters), `request.query` (query string parameters), `request.payload` (request body for POST/PUT), `request.headers`, etc.
* The `h` (response toolkit) provides methods to build and send responses, like `h.response()`, `h.file()`, `h.redirect()`, etc. Simply returning a string or object from the handler will automatically send it as a response.
* **`await server.start();`**: Starts the Hapi server.
In summary, route definition in Hapi is an integral part of your application's source code, using JavaScript objects and functions to specify the HTTP method, path, and handling logic for each endpoint.