Cannot reach API routes when using custom server

Question about Next.js

I’ve set up a custom server.js, and also create an api as /pages/api/mock.ts.

The problem is, when I tried to fetch('api/mock'), I always got response with content OK instead of a JSON. But if I start Next app without custom server, api routes works as expected.

I cannot find examples for using API route with a custom server. Here’s my configuration:

In server.js

const Koa = require('koa');
const Router = require('koa-router');
const next = require('next');

const dev = process.env.NODE_ENV !== 'production';
const port = process.env.PORT || 3000;
const app = next({ dev });
const handle = app.getRequestHandler();

app.prepare().then(() => {
	const server = new Koa();
	const router = new Router();

	server.use(router.routes());

	/* some routes except `/api/` */

	router.get('*', async (ctx, next) => {
		await handle(ctx.req, ctx.res);
	});

	server.listen(port, err => {
		if (err) {
			throw err;
		}
		console.log(`> WEB Ready on http://localhost:${port}`);
	});
});

/pages/api/mock.ts

export default (_: NextApiRequest, res: NextApiResponse) => {
	// this will be triggered but it send 'OK' back instead of a JSON string
	console.log('hit');
	const mock = JSON.stringify({data: 'foo' });
	res.setHeader('Content-Type', 'application/json; charset=UTF-8');
	res.statusCode = 200;
	res.end(mock);
};

Reproduction

Please clone this repo: https://github.com/jesseminn/next-bug-demo

[jesseminn]

Found the solution. I think it’s because Koa has built-in response handling, and setting ctx.respond = false can bypass it. Check the official documentation about ctx.respond

app.prepare().then(() => {
	const server = new Koa();
	const router = new Router();

	server.use(router.routes());

	/* some routes except `/api/` */

	router.get('*', async (ctx, next) => {
		await handle(ctx.req, ctx.res);
		ctx.respond = false;
	});

	server.listen(port, err => {
		if (err) {
			throw err;
		}
		console.log(`> WEB Ready on http://localhost:${port}`);
	});
});

[balazsorban44]

This issue has been automatically locked due to no recent activity. If you are running into a similar issue, please create a new issue with the steps to reproduce. Thank you.