With Next Endpoint

Easily turn simple functions into Next.js handlers. Includes withAuthEndpoint() for Auth0 authentication.

Example

Simple

A request to /api/getData?a=4&b=6 will return { sum: 10 }.

1// pages/api/getData.ts
2
3interface GetDataArgs {
4  a: number;
5  b: number;
6}
7
8/**
9 * Exporting allows you to call this from other API functions directly, e.g.
10 * in your frontend via `import { getData } from ...`.
11 */
12export const getData: ApiFunction<GetDataArgs> = ({ a, b }) => {
13  return {
14    sum: Number(a) + Number(b);
15  };
16}
17
18export default withEndpoint(getData);

Authentication

You can register an ApiAuthFunction to get access to the Auth0 session params. These functions can only run on the server.

1// pages/api/updateUser.ts
2
3/**
4 * Every function which relies on auth should accept a { session } param
5 * containing the Auth0 session.
6 * 
7 * You can still import this from other API functions and use it directly,
8 * simply pass the { session } param.
9 */
10export const updateUser: ApiAuthFunction<UpdateUserArgs> = ({
11  session,
12  id,
13  updates
14}) => {
15  if (isAdmin(session.user.sub)) {
16    applyChangesToUser({ id, updates });
17  }
18}
19
20/**
21 * Will wrap with Auth0's `withAuthenticationRequired` and assert a valid 
22 * session inside the handler, and accept data through POST requests instead of
23 * via URL query params. 
24 */
25export default withAuthEndpoint(updateUser, { method: "POST" });

Google Analytics

With NEXT_PUBLIC_GA_MEASUREMENT_ID and GA_API_SECRET env vars set, endpoints will automatically send Google Analytics 4 events for endpoint calls using node-google-analytics.

You can also easily use the googleAnalytics(...) function within your endpoints to send additional custom events server-side.