Step 1: How to add store-api route?<\/h2>\n\n\n\n
Begin by adding an abstract class<\/strong> that your route will extend.<\/p>\n\n\n\n Add route class<\/strong> by extending this abstract class<\/strong> and write methods as shown below,<\/p>\n\n\n\n Don’t forget to register your route in your services.xml<\/strong> file.<\/p>\n\n\n\n Now we have successfully set up our store-api route let’s see how we can add caching to it. For that, we will use the decorated class<\/strong> and implement our caching to it.<\/p>\n\n\n\n In Shopware, the caching is pre-configured for us; we simply need to utilize the appropriate classes.<\/p>\n\n\n\n We will start by adding a new class name cachedExampleRoute. This class will decorate<\/strong> our ExampleRoute class we just created above.<\/p>\n\n\n\n Inject the class in services.xml<\/strong> file<\/p>\n\n\n\n As we can see below the response before the caching took more than 2 seconds,<\/p>\n\n\n\n And after caching the results are<\/p>\n\n\n\n The caching in our API always results in better performance<\/strong> if implemented correctly. The cache can also result in outdated data<\/strong> and security risks<\/strong> if not set up properly. For a detailed guide on how to add cache in store API check out shopware official documentation<\/a>. <\/p>\n\n\n\n If you need custom Shopware Development Services<\/a> then feel free to reach us<\/a> and also explore our exclusive range of Shopware Plugins<\/a>.<\/p>\n\n\n\n Have fun and keep coding!<\/p>\n","protected":false},"excerpt":{"rendered":"<plugin Root>\/src\/Core\/Content\/Example\/SalesChannel\/AbstractExampleRoute.php\n\n<?php declare(strict_types=1);\n\nnamespace Webkul\\BasicExample\\Core\\Content\\Example\\SalesChannel;\n\nuse Shopware\\Core\\Framework\\DataAbstractionLayer\\Search\\Criteria;\nuse Shopware\\Core\\System\\SalesChannel\\SalesChannelContext;\n\nabstract class AbstractExampleRoute\n{\n abstract public function getDecorated(): AbstractExampleRoute;\n\n abstract public function load(Criteria $criteria, SalesChannelContext $context): ExampleRouteResponse;\n}<\/pre>\n\n\n\n<plugin Root>\/src\/Core\/Content\/Example\/SalesChannel\/ExampleRoute.php\n\n<?php declare(strict_types=1);\n\nnamespace Webkul\\BasicExample\\Core\\Content\\Example\\SalesChannel;\n\nuse Shopware\\Core\\Framework\\DataAbstractionLayer\\EntityRepository;\nuse Shopware\\Core\\Framework\\DataAbstractionLayer\\Search\\Criteria;\nuse Shopware\\Core\\Framework\\Plugin\\Exception\\DecorationPatternException;\nuse Shopware\\Core\\Framework\\Routing\\Annotation\\Entity;\nuse Shopware\\Core\\System\\SalesChannel\\SalesChannelContext;\nuse Symfony\\Component\\Routing\\Annotation\\Route;\n\n\/**\n * @Route(defaults={"_routeScope"={"store-api"}})\n *\/\nclass ExampleRoute extends AbstractExampleRoute\n{\n protected EntityRepository $exampleRepository;\n\n public function __construct(EntityRepository $exampleRepository)\n {\n $this->exampleRepository = $exampleRepository;\n }\n\n public function getDecorated(): AbstractExampleRoute\n {\n throw new DecorationPatternException(self::class);\n }\n\n \/**\n * @Entity("blog_example")\n * @Route("\/store-api\/example", name="store-api.example.search", methods={"GET", "POST"})\n *\/\n public function load(Criteria $criteria, SalesChannelContext $context): ExampleRouteResponse\n {\n $results = $this->exampleRepository->search($criteria, $context->getContext());\n return new ExampleRouteResponse($results );\n }\n}<\/pre>\n\n\n\n<services>\n <service id="Webkul\\BasicExample\\Core\\Content\\Example\\SalesChannel\\ExampleRoute" >\n <argument type="service" id="blog_example.repository"\/>\n <\/service>\n<\/services><\/pre>\n\n\n\n
Step 2: How to add a caching layer in store-API route?<\/h2>\n\n\n\n
<?php declare(strict_types=1);\n\nnamespace Webkul\\BasicExample\\Core\\Content\\Example\\SalesChannel;\n\nuse Psr\\Log\\LoggerInterface;\nuse Shopware\\Core\\Framework\\Adapter\\Cache\\CacheStateSubscriber;\nuse Shopware\\Core\\System\\SalesChannel\\SalesChannelContext;\nuse Shopware\\Core\\Framework\\Adapter\\Cache\\AbstractCacheTracer;\nuse Shopware\\Core\\Framework\\Adapter\\Cache\\CacheCompressor;\nuse Shopware\\Core\\Framework\\DataAbstractionLayer\\Cache\\EntityCacheKeyGenerator;\nuse Symfony\\Component\\Cache\\Adapter\\TagAwareAdapterInterface;\nuse Shopware\\Core\\Framework\\DataAbstractionLayer\\Search\\Criteria;\nuse Shopware\\Core\\Framework\\DataAbstractionLayer\\FieldSerializer\\JsonFieldSerializer;\nuse Shopware\\Core\\Framework\\Routing\\Annotation\\Entity;\nuse Symfony\\Component\\Routing\\Annotation\\Route;\nuse Webkul\\Core\\Content\\Blog\\SalesChannel\\BlogRouteResponse;\n\n\/**\n * @Route(defaults={"_routeScope"={"store-api"}})\n *\/\nclass CachedExampleRoute extends AbstractExampleRoute\n{\n private AbstractExampleRoute $decorated;\n\n private TagAwareAdapterInterface $cache;\n\n private EntityCacheKeyGenerator $generator;\n\n private AbstractCacheTracer $tracer;\n\n private array $states;\n\n private LoggerInterface $logger;\n\n public function __construct(\n AbstractExampleRoute $decorated,\n TagAwareAdapterInterface $cache,\n EntityCacheKeyGenerator $generator,\n AbstractCacheTracer $tracer,\n LoggerInterface $logger\n ) {\n $this->decorated = $decorated;\n $this->cache = $cache;\n $this->generator = $generator;\n $this->tracer = $tracer;\n \n \/\/ declares that this route can not be cached if the customer is logged in\n $this->states = [CacheStateSubscriber::STATE_LOGGED_IN];\n $this->logger = $logger;\n }\n \n public function getDecorated(): AbstractExampleRoute\n {\n return $this->decorated;\n }\n\n \/**\n * @Entity("blog_example")\n * @Route("\/store-api\/example", name="store-api.example.search", methods={"GET", "POST"})\n *\/\n public function load(Criteria $criteria, SalesChannelContext $context): ExampleRouteResponse\n {\n \/\/ The context is provided with a state where the route cannot be cached\n if ($context->hasState(...$this->states)) {\n return $this->getDecorated()->load($criteria, $context);\n }\n\n \/\/ Fetch item from the cache pool\n $item = $this->cache->getItem(\n $this->generateKey($context, $criteria)\n );\n\n try {\n if ($item->isHit() && $item->get()) {\n \/\/ Use cache compressor to uncompress the cache value\n return CacheCompressor::uncompress($item);\n }\n } catch (\\Throwable $e) {\n \/\/ Something went wrong when uncompress the cache item - we log the error and continue to overwrite the invalid cache item \n $this->logger->error($e->getMessage());\n }\n\n $name = self::buildName();\n \/\/ start tracing of nested cache tags and system config keys\n $response = $this->tracer->trace($name, function () use ($criteria, $context) {\n return $this->getDecorated()->load($criteria, $context);\n });\n \n \/\/ compress cache content to reduce cache size\n $item = CacheCompressor::compress($item, $response);\n\n $item->tag(array_merge(\n \/\/ get traced tags and configs \n $this->tracer->get(self::buildName()),\n [self::buildName()]\n ));\n\n $this->cache->save($item);\n\n return $response;\n }\n \n public static function buildName(): string \n {\n return 'example-route';\n }\n \n private function generateKey(SalesChannelContext $context, Criteria $criteria): string\n {\n $parts = [\n self::buildName(),\n \/\/ generate a hash for the route criteria\n $this->generator->getCriteriaHash($criteria),\n \/\/ generate a hash for the current context \n $this->generator->getSalesChannelContextHash($context),\n ];\n \n return md5(JsonFieldSerializer::encodeJson($parts));\n }\n}<\/pre>\n\n\n\n<service \n id="<pluginRoot>\\Core\\Content\\Example\\SalesChannel\\CachedExampleRoute" decorates="Webkul\\BasicExample\\Core\\Content\\Example\\SalesChannel\\ExampleRoute">\n <argument type="service" id=" <pluginRoot>\\Core\\Content\\Example\\SalesChannel\\CachedExampleRoute.inner"\/>\n <argument type="service" id="cache.object"\/>\n <argument type="service" id="Shopware\\Core\\Framework\\DataAbstractionLayer\\Cache\\EntityCacheKeyGenerator"\/>\n <argument type="service" id="Shopware\\Core\\Framework\\Adapter\\Cache\\CacheTracer"\/>\n <argument type="service" id="logger" \/>\n<\/service><\/pre>\n\n\n\n
![\"before](\"https:\/\/cdnblog.webkul.com\/blog\/wp-content\/uploads\/2023\/08\/BeforeCache-1200x566.png\")
![\"after](\"https:\/\/cdnblog.webkul.com\/blog\/wp-content\/uploads\/2023\/08\/AfterCache-1-1200x568.png\")
Conclusion<\/h2>\n\n\n\n