API Route Filter
The API Route Filter in Convoworks API Builder allows you to define filters for your API routes. This is useful when you want to match specific API routes during the request.
Properties
- Method: This is the HTTP method for the API route, such as GET, POST, PUT, DELETE, etc. You can use "*" to match any
- Path: This field is used to specify the URI path for the route. You can use path variables within the URI path to capture specific portions of the URI.
When a route is matched, you can use expressions like
${result.userId} to get the value of the path variable.
Path is appended to the service base url which can be obtained on the Releases view.
This field supports several special values:
- If left empty, it will match the default route.
- If set to "*", it will match all routes.
- If you define the route as "/my/{userId}", and the route is matched,
${result.userId} can be used to get the path variable value.