JSS Layout API
Sitecore JavaScript Rendering SDK (JSS) provides an API to help you retrieve information about layouts from Sitecore.
When using JSS, you can get layout data from several endpoints, without worrying about data fetching implementation details. The JSS Layout API abstracts data fetching implementation details into services, clients, and data fetchers for REST and GraphQL endpoints. See some usage examples.
Sitecore endpoints for layout data
There are several options for fetching layout information from Sitecore:
-
Call the REST Layout Service endpoint provided by Sitecore Headless Services.
-
Query the Sitecore Edge Preview GraphQL endpoint provided by Headless Services. Sitecore Edge Preview GraphQL API is an implementation of a GraphQL server on top of Sitecore. The Sitecore GraphQL schema mirrors the Experience Edge schema.
-
Query the GraphQL endpoint provided by Sitecore Experience Edge for XM. Sitecore Experience Edge for XM comes with a read-only GraphQL schema designed to accommodate common front-end use cases for headless Sitecore development.
-
Query the Sitecore GraphQL Endpoint, the first-ever GraphQL endpoint introduced by JSS Server Components. This endpoint is currently only used by React, Angular, and Vue sample applications versions 18.0.0 and earlier.
You can choose whether you want to use REST or GraphQL endpoints when creating your JSS application with the parameter --fetchWith REST
or --fetchWith GraphQL
.