Hatthi

Filter the project's routes by a query string and/or by routes properties.

Available filters are:

• Group - only show routes of a certain group or all available routes
• Verb - only show routes having certain verb or all available routes
• Auth - only show routes that are either do or do not require authentication or all available routes

The Auth filter is only available if your project is setup to support configuration.

Routes can be grouped and groups can have names or be the <Main Group>, which has no name and is not editable.

To rename a group simply insert the new group name in the input field.

Here you have a basic summary of each route defined in your project.

You can find the verb of the the route, its name, the url it is reachable at and a few optional icons that represent the return type of the route if it requires authentication, permissions or roles to be accessed and if this route is also an Api endpoint.

When hovering with the mouse over each row, 5 buttons appear on the right side, which allow different operations on the route.

You can assign a new group to the selected route. Typing the name of an existing group will move the route to that group.

If the typed name doesn't exist as a group, a new group will be created containing the selected route.

Alternatively you can copy the route in an existing group, or move it directly by selecting the destination group.

Routes can be deleted after confirming the deletion on the appearing dialog.

You can edit each of the summurized elements from above, to do so, expand a row and edit routes details.

Routes are accessed with verbs. Usually all GET routes are intended for reading, other verbs are intended for creating, updating and deleting.

Select the verb the route can be accessed by selecting it from the list. Availables verbs are GET, POST, PUT, and DELETE.

You can optionally input an url suffix for the selected route

Each route has a name to be easily identifiable across the whole project.

You can choose the name you want for each route.

Routes can have parameters which are passed in the url.

Add a new parameter by clicking the plus button ().

Routes can be constrained to be reachable only by authenticated users.

Check the models you want to be able to reach the route when authenticated. Unauthenticated users won't be able to reach that route.

Routes can be constrained to be reachable only by authenticated users having certain roles.

Add a new role by clicking the plus button().

Select the role you want to constrain the route to and optionally add more.

Routes can be constrained to be reachable only by authenticated users having certain permissions.

Add a new permission by clicking the plus button().

Select the permission you want to constrain the route to and optionally add more.

Once a route is executed it will return a response back.

For GET routes there are 3 different response types available:

• Html - the response will be an HTML () string
• Json - the response will be a JSON ()string
• Both - the response type will be decided based on what the request accepts back.