Install the Catalog Glue API
Edit on GitHubInstall Feature API
Prerequisites
Install the required features:
NAME | VERSION | INSTALLATION GUIDE |
---|---|---|
Spryker Core | 202307.0 | Install the Spryker Core Glue API |
Search | 202307.0 | |
Catalog | 202307.0 | |
Product | 202307.0 | Install the Product Glue API |
Catalog + Price | 202307.0 |
1) Install the required modules
Run the following command to install the required modules:
composer require spryker/catalog-search-rest-api:"^2.1.2" spryker/catalog-search-products-resource-relationship:"^1.1.0" --update-with-dependencies
Make sure the following modules have been installed:
MODULE | EXPECTED DIRECTORY |
---|---|
CatalogSearchRestApi | vendor/spryker/catalog-search-rest-api |
CatalogSearchProductsResourceRelationship | vendor/spryker/catalog-search-products-resource-relationship |
2) Set up transfer objects
Run the following command to generate transfer changes:
console transfer:generate
Make sure that the following changes have occurred in transfer objects:
TRANSFER | TYPE | EVENT | PATH |
---|---|---|---|
RestCatalogSearchAttributesTransfer | class | created | src/Generated/Shared/Transfer/RestCatalogSearchAttributesTransfer |
RestCatalogSearchSortTransfer | class | created | src/Generated/Shared/Transfer/RestCatalogSearchSortTransfer |
RestCatalogSearchPaginationTransfer | class | created | src/Generated/Shared/Transfer/RestCatalogSearchPaginationTransfer |
RestCatalogSearchAbstractProductsTransfer | class | created | src/Generated/Shared/Transfer/RestCatalogSearchAbstractProductsTransfer |
RestCatalogSearchProductImageTransfer | class | created | src/Generated/Shared/Transfer/RestCatalogSearchProductImageTransfer |
RestRangeSearchResultTransfer | class | created | src/Generated/Shared/Transfer/RestRangeSearchResultTransfer |
RestFacetSearchResultTransfer | class | created | src/Generated/Shared/Transfer/RestFacetSearchResultTransfer |
RestCatalogSearchSuggestionsAttributesTransfer | class | created | src/Generated/Shared/Transfer/RestCatalogSearchSuggestionsAttributesTransfer |
RestCatalogSearchSuggestionAbstractProductsTransfer | class | created | src/Generated/Shared/Transfer/RestCatalogSearchSuggestionAbstractProductsTransfer |
RestCatalogSearchSuggestionProductImageTransfer | class | created | src/Generated/Shared/Transfer/RestCatalogSearchSuggestionProductImageTransfer |
RestPriceProductTransfer | class | created | src/Generated/Shared/Transfer/RestPriceProductTransfer |
PriceModeConfigurationTransfer | class | created | src/Generated/Shared/Transfer/PriceModeConfigurationTransfer |
RestCurrencyTransfer | class | created | src/Generated/Shared/Transfer/RestCurrencyTransfer |
RestFacetConfigTransfer | class | created | src/Generated/Shared/Transfer/RestFacetConfigTransfer |
3) Set up behavior
Enable resources and relationships
Activate the following plugins:
PLUGIN | SPECIFICATION | PREREQUISITES | NAMESPACE |
---|---|---|---|
CatalogSearchAbstractProductsResourceRelationshipPlugin | Adds the abstract-products resource relationship to search results. |
None | Spryker\Glue\CatalogSearchProductsResourceRelationship\Plugin |
CatalogSearchSuggestionsAbstractProductsResourceRelationshipPlugin | Adds the abstract-products resource relationship to search suggestions results. |
None | Spryker\Glue\CatalogSearchProductsResourceRelationship\Plugin |
CatalogSearchResourceRoutePlugin | Registers the search resource. |
None | Spryker\Glue\CatalogSearchRestApi\Plugin |
CatalogSearchSuggestionsResourceRoutePlugin | Registers the search-suggestions resource. |
None | Spryker\Glue\CatalogSearchRestApi\Plugin |
src/Pyz/Glue/GlueApplication/GlueApplicationDependencyProvider.php
<?php
namespace Pyz\Glue\GlueApplication;
use Spryker\Glue\CatalogSearchProductsResourceRelationship\Plugin\CatalogSearchAbstractProductsResourceRelationshipPlugin;
use Spryker\Glue\CatalogSearchProductsResourceRelationship\Plugin\CatalogSearchSuggestionsAbstractProductsResourceRelationshipPlugin;
use Spryker\Glue\CatalogSearchRestApi\CatalogSearchRestApiConfig;
use Spryker\Glue\CatalogSearchRestApi\Plugin\CatalogSearchResourceRoutePlugin;
use Spryker\Glue\CatalogSearchRestApi\Plugin\CatalogSearchSuggestionsResourceRoutePlugin;
use Spryker\Glue\GlueApplication\GlueApplicationDependencyProvider as SprykerGlueApplicationDependencyProvider;
use Spryker\Glue\GlueApplicationExtension\Dependency\Plugin\ResourceRelationshipCollectionInterface;
class GlueApplicationDependencyProvider extends SprykerGlueApplicationDependencyProvider
{
/**
* @return \Spryker\Glue\GlueApplicationExtension\Dependency\Plugin\ResourceRoutePluginInterface[]
*/
protected function getResourceRoutePlugins(): array
{
return [
new CatalogSearchResourceRoutePlugin(),
new CatalogSearchSuggestionsResourceRoutePlugin(),
];
}
/**
* @param \Spryker\Glue\GlueApplicationExtension\Dependency\Plugin\ResourceRelationshipCollectionInterface $resourceRelationshipCollection
*
* @return \Spryker\Glue\GlueApplicationExtension\Dependency\Plugin\ResourceRelationshipCollectionInterface
*/
protected function getResourceRelationshipPlugins(
ResourceRelationshipCollectionInterface $resourceRelationshipCollection
): ResourceRelationshipCollectionInterface {
$resourceRelationshipCollection->addRelationship(
CatalogSearchRestApiConfig::RESOURCE_CATALOG_SEARCH,
new CatalogSearchAbstractProductsResourceRelationshipPlugin()
);
$resourceRelationshipCollection->addRelationship(
CatalogSearchRestApiConfig::RESOURCE_CATALOG_SEARCH_SUGGESTIONS,
new CatalogSearchSuggestionsAbstractProductsResourceRelationshipPlugin()
);
return $resourceRelationshipCollection;
}
}
If CatalogSearchResourceRoutePlugin
and CatalogSearchSuggestionsResourceRoutePlugin
are installed correctly, the following endpoints should now be available:
https://glue.mysprykershop.com/catalog-search?q={{q_term}}
https://glue.mysprykershop.com/catalog-search-suggestions?q={{q_term}}
To make sure that CatalogSearchAbstractProductsResourceRelationshipPlugin
and CatalogSearchSuggestionsAbstractProductsResourceRelationshipPlugin
are functioning correctly, do the following:
Send a request to https://glue.mysprykershop.com/catalog-search?q={{q_term}}&include=abstract-products
and verify that the response includes relationships to abstract-products
resources.
Send a request to https://glue.mysprykershop.com/catalog-search-suggestions?q={{q_term}}&include=abstract-products
and verify that the response includes relationships to abstract-products
resources.
Thank you!
For submitting the form