ecwhim/module-canonical-url-graph-ql

N/A

1.0.0 2022-10-24 20:51 UTC

Requires

• ecwhim/module-canonical-urls: >=1.1.0
• magento/module-graph-ql: ^100.3

OSL-3.0, AFL-3.0

README

This module provides support of Magento GraphQL for Magento 2 Canonical URL Extension by Ecwhim.

Installation

You can install the module in the following ways:

1. Install the module using Composer via packagist.com.
2. Download package from github.com.

Install the module using Composer via packagist.com

1. Log in to your Magento server as, or switch to, the file system owner.
2. Navigate to your Magento project directory.
3. Get the latest version of the module:

composer require ecwhim/module-canonical-url-graph-ql

1. Enable the module.

Download package from github.com

1. Download the latest version of the package from github.
2. Extract the package to the <magento root directory>/app/code/Ecwhim/CanonicalUrlGraphQl directory.
3. Enable the module.

How to use

CategoryInterface attribute

The following table defines the CategoryInterface attribute added by our extension.

ATTRIBUTE	DATA TYPE	DESCRIPTION
ecw_canonical_url	String	The absolute canonical URL.

Example Usage

The following query shows how to get the canonical URL for a category:

Request:

{
    categoryList(filters: {ids: {eq: "14"}}){
        id
        name
        ecw_canonical_url
    }
}

Response:

{
    "data": {
        "categoryList": [
            {
                "id": 14,
                "name": "Jackets",
                "ecw_canonical_url": "https://example.com/men/tops-men/jackets-men.html"
            }
        ]
    }
}

CmsPage attribute

The following table defines the CmsPage attribute added by our extension.

ATTRIBUTE	DATA TYPE	DESCRIPTION
ecw_canonical_url	String	The absolute canonical URL.

Example Usage

The following query shows how to get the canonical URL for a CMS page:

Request:

{
    cmsPage(identifier: "customer-service") {
        identifier
        title
        ecw_canonical_url
    }
}

Response:

{
    "data": {
        "cmsPage": {
            "identifier": "customer-service",
            "title": "Customer Service",
            "ecw_canonical_url": "https://example.com/customer-service"
        }
    }
}

ProductInterface attribute

The following table defines the ProductInterface attribute added by our extension.

ATTRIBUTE	DATA TYPE	DESCRIPTION
ecw_canonical_url	String	The absolute canonical URL.

Example Usage

The following query shows how to get the canonical URL for a product:

Request:

{
    products(filter: { sku: { eq: "24-MB01" } }) {
        items {
            name
            sku
            ecw_canonical_url
        }
    }
}

Response:

{
    "data": {
        "products": {
            "items": [
                {
                    "name": "Joust Duffle Bag",
                    "sku": "24-MB01",
                    "ecw_canonical_url": "https://example.com/joust-duffle-bag.html"
                }
            ]
        }
    }
}