Hatthi

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

Available filters are:

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

The Auth filter is only available if your project is set up to support this configuration.

To manage routes easier, you may want to group them. When creating a new group, you can set its name.

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 at which it is reachable 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 group that you have typed doesn't exist, a new group will be created containing the selected route.

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

Routes can be deleted after confirming the deletion in the appearing dialog box.

To edit route settings, expand a row and enter route's 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 with which 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. This helps the route to be easily identifiable across the whole project.

You can choose a name for each route.

Routes can have parameters which are passed in the url.

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

You can restrict the access to certain routes to authenticated instances of certain models only.

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

You can further limit the access to certain routes so that only authenticated models having certain roles can reach them.

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

Select the role to which you want to limit the route access. You can add as many such roles as you need.

Similarly, you can limit the access to certain routes so that only authenticated models having certain permissions can reach them.

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

Select the permission to which you want to limit the route access. You can add as many such permissions as you need.

Once a route is executed it will return a response.

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.