Routing Management

The Routing feature in GimCore allows administrators to define and manage how requests are processed and directed within the system. This comprehensive guide outlines the procedures for accessing, configuring, and maintaining routing rules.

Accessing Routing Management 🧭

To access the Routing management interface:

1. Navigate to the Routing menu item in the left-hand navigation panel.
2. Clicking on Routing will direct you to the main Routing overview screen.

Routing Overview and Data Table 📊

The Routing screen displays a data table listing all configured routing entries. This table provides an overview of each entry's key properties.

Detected UI Elements:

• Search: Use the search bar to filter the list of routing entries by keywords.
• Total: Displays the total number of routing entries configured in the system.

Columns in the Routing Data Table:

• Method: Indicates the HTTP method (e.g., GET, POST, PUT, DELETE) associated with the routing rule.
• Path: Shows the URL path pattern that this routing rule matches.
• Resource: Specifies the internal resource or controller that will handle requests matching this rule.
• Actions: This column contains action icons for managing individual routing entries:
  • Edit (Pencil icon) 📝: Click this icon to modify an existing routing entry.
  • Delete (Trash icon) 🗑️: Click this icon to remove a routing entry from the system.

Adding a New Routing Entry ➕

To create a new routing entry:

1. Click the Add New button, typically located at the top right of the page header.
2. A modal dialog will appear, presenting fields for defining the new routing rule.
3. Method: Select the HTTP method (e.g., GET, POST) for this route.
4. Path: Enter the specific URL path for this route (e.g., /api/v1/users).
5. Resource: Specify the internal system resource (e.g., UsersController@index) that this route should invoke.
6. Create: Click this button within the modal to save the new routing entry.

Editing an Existing Routing Entry 📝

To modify an existing routing rule:

1. Locate the desired routing entry in the data table.
2. Click the Edit (Pencil icon) 📝 in the Actions column for that entry.
3. A modal dialog will open, pre-populated with the current details of the routing entry.
4. Method: Modify the HTTP method as needed.
5. Path: Adjust the URL path if required.
6. Resource: Change the associated internal resource if the handling logic has moved or changed.
7. Update: Click this button within the modal to save your changes.

Deleting a Routing Entry 🗑️

To remove a routing entry from the system:

1. Locate the routing entry you wish to delete in the data table.
2. Click the Delete (Trash icon) 🗑️ in the Actions column for that entry.
3. A confirmation dialog will appear, asking you to confirm the deletion.
4. Confirm the action to permanently remove the routing entry.