NextJS: Short URL for Viewing Layout Service Response

> Because the default URL is 2long4me
Cover Image for NextJS: Short URL for Viewing Layout Service Response

The age of JSS + Headless + NextJS is all about quality of life improvements for developers. Here's a good one for you.

Often, it's helpful to be able to ping the layout service to see what data you're working with. The problem is that the URL is tricky to remember. You could bookmark it, but what about other devs who don't have the bookmark? Let's make it easier for everyone.

[[...path]].ts

_36
// This code makes it easier to ping your layout service without having to remember the long URL that is accessible by default.
_36
// Add this file to /pages/api/viewpage or wherever you want.
_36
// From there, all you need to do is visit /api/viewpage to view the layout service response for your home page
_36
// Subpage would be /api/viewpage/someSubPage
_36
import type { NextApiRequest, NextApiResponse } from 'next';
_36
_36
const handler = async (req: NextApiRequest, res: NextApiResponse): Promise<void> => {
_36
const apiHost = process.env.SITECORE_API_HOST
_36
? process.env.SITECORE_API_HOST
_36
: `https://mysite.sc`;
_36
_36
const siteName = process.env.NEXT_PUBLIC_JSS_SITE_NAME
_36
? process.env.NEXT_PUBLIC_JSS_SITE_NAME
_36
: `main`;
_36
_36
const apiKey = process.env.SITECORE_API_KEY
_36
? process.env.SITECORE_API_KEY
_36
: `{CHANGEME}`;
_36
_36
const { path } = req.query;
_36
const itemPath = path ? path : '/';
_36
_36
if (typeof itemPath === 'string') {
_36
queryStringPath = itemPath;
_36
} else {
_36
queryStringPath = itemPath.join('/');
_36
}
_36
_36
const layoutServiceResponse = await fetch(
_36
`${apiHost}/sitecore/api/layout/render/jss/?sc_lang=en&sc_site=${siteName}&sc_apikey=${apiKey}&item=${queryStringPath}`
_36
);
_36
_36
res.status(200).json(await layoutServiceResponse.json());
_36
};
_36
_36
export default handler;

The above solution may not work in all cases. The solution above is for a solution that's configured with REST, however content can also be fetched with GraphQL, and that's where everything is headed (Experience Edge / XM Cloud). I haven't looked yet, but the layout service may not be present, or the method by which one could fetch that data may be different.

Another possible (and potentially more future proof) solution is:

[[...path]].ts

_19
import type { NextApiRequest, NextApiResponse } from 'next';
_19
import { GetServerSidePropsContext, GetStaticPropsContext } from 'next';
_19
import { sitecorePagePropsFactory } from 'lib/page-props-factory';
_19
_19
const handler = async (req: NextApiRequest, res: NextApiResponse): Promise<void> => {
_19
const { path } = req.query;
_19
_19
const context: GetServerSidePropsContext | GetStaticPropsContext = {
_19
params: {
_19
path: path,
_19
},
_19
};
_19
_19
const props = await sitecorePagePropsFactory.create(context);
_19
_19
res.status(200).json(props.layoutData);
_19
};
_19
_19
export default handler;

layout-service-factory.ts

_27
import {
_27
LayoutService,
_27
RestLayoutService,
_27
GraphQLLayoutService,
_27
} from '@sitecore-jss/sitecore-jss-nextjs';
_27
import config from 'temp/config';
_27
_27
export class LayoutServiceFactory {
_27
create(): LayoutService {
_27
return process.env.FETCH_WITH === 'GraphQL'
_27
? new GraphQLLayoutService({
_27
endpoint: config.graphQLEndpoint,
_27
apiKey: config.sitecoreApiKey,
_27
siteName: config.jssAppName,
_27
})
_27
: new RestLayoutService({
_27
apiHost: config.sitecoreApiHost,
_27
apiKey: config.sitecoreApiKey,
_27
siteName: config.jssAppName,
_27
_27
// CHANGE THIS FROM 'default' TO 'jss'
_27
configurationName: 'jss',
_27
});
_27
}
_27
}
_27
_27
export const layoutServiceFactory = new LayoutServiceFactory();

Note that this endpoint will be PUBLICLY VIEWABLE, so make sure to lock it down somehow, possibly with this or WAF rules.

Pair this solution with a browser extension that formats JSON, and you're off to the races.

-MG


More Stories

Cover Image for Don't Ignore the HttpRequestValidationException

Don't Ignore the HttpRequestValidationException

> Doing so could be... potentially dangerous

Cover Image for Troubleshooting 502 Responses in Azure App Services

Troubleshooting 502 Responses in Azure App Services

> App Services don't support all libraries

Cover Image for Tips for Applying Cumulative Sitecore XM/XP Patches and Hotfixes

Tips for Applying Cumulative Sitecore XM/XP Patches and Hotfixes

> It's probably time to overhaul your processes

Cover Image for Early Returns in React Components

Early Returns in React Components

> When and how should you return early in a React component?

Cover Image for How to Run Old Versions of Solr in a Docker Container

How to Run Old Versions of Solr in a Docker Container

> Please don't make me install another version of Solr on my local...

Cover Image for On Mentorship and Community Contributions

On Mentorship and Community Contributions

> Reflections and what I learned as an MVP mentor

Cover Image for NextJS: Access has been blocked by CORS policy

NextJS: Access has been blocked by CORS policy

> CORS is almost as much of a nuisance as GDPR popups

Cover Image for SPE Script Performance & Troubleshooting

SPE Script Performance & Troubleshooting

> Script never ends or runs too slow? Get in here.

Cover Image for Sitecore Symposium 2022

Sitecore Symposium 2022

> What I'm Watching 👀

Cover Image for Add TypeScript Type Checks to RouteData fields

Add TypeScript Type Checks to RouteData fields

> Inspired by error: Conversion of type may be a mistake because neither type sufficiently overlaps with the other.

Cover Image for On Sitecore Stack Exchange (SSE)

On Sitecore Stack Exchange (SSE)

> What I've learned, what I see, what I want to see

Cover Image for Hello World

Hello World

> Welcome to the show

Cover Image for NextJS: Unable to Verify the First Certificate

NextJS: Unable to Verify the First Certificate

> UNABLE_TO_VERIFY_LEAF_SIGNATURE

Cover Image for Super Fast Project Builds with Visual Studio Publish

Super Fast Project Builds with Visual Studio Publish

> For when solution builds take too long

Cover Image for Azure PaaS Cache Optimization

Azure PaaS Cache Optimization

> App Services benefit greatly from proper configuration

Cover Image for JSS: Reducing Bloat in Multilist Field Serialization

JSS: Reducing Bloat in Multilist Field Serialization

> Because: performance, security, and error-avoidance

Cover Image for Script: Boost SIF Certificate Expiry Days

Script: Boost SIF Certificate Expiry Days

> One simple script that definitely won't delete your system32 folder

Cover Image for JSS + TypeScript Sitecore Project Tips

JSS + TypeScript Sitecore Project Tips

> New tech, new challenges

Cover Image for Ideas For Docker up.ps1 Scripts

Ideas For Docker up.ps1 Scripts

> Because Docker can be brittle

Cover Image for Year in Review: 2022

Year in Review: 2022

> Full steam ahead

Cover Image for Tips for New Sitecore Developers

Tips for New Sitecore Developers

> Because learning Sitecore can be hard

Cover Image for Symposium 2022 Reflections

Symposium 2022 Reflections

> Sitecore is making big changes

Cover Image for Content Editor Search Bar Not Working

Content Editor Search Bar Not Working

> Sometimes it works, sometimes not

Cover Image for Tips for Forms Implementations

Tips for Forms Implementations

> And other pro tips

Cover Image for NextJS/JSS Edit Frames Before JSS v21.1.0

NextJS/JSS Edit Frames Before JSS v21.1.0

> It is possible. We have the technology.