Setting Up Routes in a Module

File Location

Create etc/frontend/routes.xml in your module:

app/code/Amazon/Prep/etc/frontend/routes.xml

Complete Configuration

<?xml version="1.0"?>
<config xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
        xsi:noNamespaceSchemaLocation="urn:magento:framework:App/etc/routes.xsd">
    <router id="standard">
        <route id="amazon_prep" frontName="amazon_prep">
            <module name="Amazon_Prep"/>
        </route>
    </router>
</config>

Front Name Rules

• Use lowercase with underscores: amazon_prep
• Should be unique across all modules
• Becomes the first segment of your URLs
• Convention: match the module name in snake_case

URL Structure

With front name amazon_prep:

amazon_prep/index/index     → Controller/Index/Index.php
amazon_prep/product/view     → Controller/Product/View.php
amazon_prep/warranty/list    → Controller/Warranty/List.php

Multiple Routes Per Module

<router id="standard">
    <route id="amazon_prep" frontName="amazon_prep">
        <module name="Amazon_Prep"/>
    </route>
    <route id="amazon_prep_api" frontName="amazon_prep_api">
        <module name="Amazon_Prep"/>
    </route>
</router>

This gives you two URL prefixes:

• amazon_prep/* for frontend pages
• amazon_prep_api/* for API-style endpoints

Index Action (Default Page)

<?php
namespace Amazon\Prep\Controller\Index;

use Magento\Framework\App\Action\HttpGetActionInterface;
use Magento\Framework\Result\Page;
use Magento\Framework\Result\PageFactory;

class Index implements HttpGetActionInterface
{
    public function __construct(
        private PageFactory $resultPageFactory
    ) {}

    public function execute(): Page
    {
        $page = $this->resultPageFactory->create();
        $page->getConfig()->getTitle()->set(__('Amazon Prep Dashboard'));
        return $page;
    }
}

URL: amazon_prep/index/index

View Action

<?php
namespace Amazon\Prep\Controller\Product;

use Magento\Framework\App\Action\HttpGetActionInterface;
use Magento\Framework\Result\Page;
use Magento\Framework\Result\PageFactory;

class View implements HttpGetActionInterface
{
    public function __construct(
        private PageFactory $resultPageFactory
    ) {}

    public function execute(): Page
    {
        $productId = $this->getRequest()->getParam('id');

        $page = $this->resultPageFactory->create();
        $page->getConfig()->getTitle()->set(__('Product View'));

        // Pass data to block via layout
        $page->getLayout()->getBlock('product.view')
            ->setData('product_id', $productId);

        return $page;
    }
}

URL: amazon_prep/product/view/id/5

Save Action (POST)

<?php
namespace Amazon\Prep\Controller\Index;

use Magento\Framework\App\Action\HttpPostActionInterface;
use Magento\Framework\Controller\Result\RedirectFactory;
use Magento\Framework\Message\ManagerInterface;

class Save implements HttpPostActionInterface
{
    public function __construct(
        private RedirectFactory $resultRedirectFactory,
        private ManagerInterface $messageManager
    ) {}

    public function execute()
    {
        try {
            $name = $this->getRequest()->getParam('name');
            // Save logic here
            $this->messageManager->addSuccessMessage(__('Saved successfully.'));
        } catch (\Exception $e) {
            $this->messageManager->errorMessage($e->getMessage());
        }

        return $this->resultRedirectFactory->create()
            ->setPath('amazon_prep/index/index');
    }
}

URL: amazon_prep/index/save (POST only)

Browser Testing

1. Clear cache first:

bin/magento cache:clean

2. Open browser and navigate to:

http://your-magento.com/amazon_prep/index/index

3. Check if page loads without 404 error.

CLI Testing with curl

# Test GET request
curl -v http://localhost/amazon_prep/index/index

# Test with parameters
curl -v "http://localhost/amazon_prep/product/view/id/5"

# Test POST request
curl -X POST http://localhost/amazon_prep/index/save \
     -d "name=Test+Product"

Debug Route Matching

Enable route logging:

// In app/etc/env.php, "add":
'system' => [
    'debug' => [
        'log_router_enabled' => true,
    ],
],

Then check var/log/system.log:

[2024-01-15 10:30:00] main.DEBUG: Matched route "amazon_prep" []

Check Compiled Routes

bin/magento setup:di:compile
grep -r "amazon_prep" var/di/

Common Route Issues

404 Not Found

# Check if module is enabled
bin/magento module:status Amazon_Prep

# Check routes.xml exists
dir app/code/Amazon/Prep/etc/frontend/routes.xml

# Check XML is valid (no syntax errors)
php -l app/code/Amazon/Prep/etc/frontend/routes.xml

# Clear cache
bin/magento cache:clean

Controller Not Found

# Error: Class Amazon\Prep\Controller\Index\Index does not exist

# Check namespace matches directory structure
# File: app/code/Amazon/Prep/Controller/Index/Index.php
# Namespace: Amazon\Prep\Controller\Index

Wrong HTTP Method

# Error: Requested HTTP method is not allowed

# Check action implements correct interface:
# HttpGetActionInterface for GET
# HttpPostActionInterface for POST