How can i get a list of Koa server url routes

In Koa, we typically use the koa-router library to handle routing-related functionalities. koa-router provides flexible methods for defining routes and executing corresponding actions. However, directly retrieving all registered route paths from the Koa server is not a feature natively supported by koa-router. Nevertheless, we can indirectly obtain the route list through certain methods.

Method One: Storing Route Information During Definition

The simplest and most direct approach is to store relevant information when defining routes. This allows you to access the storage at any time to retrieve the current route list.

javascript
const Koa = require('koa');
const Router = require('@koa/router');

const app = new Koa();
const router = new Router();

// Create an array to store route information
const routeList = [];

router.get('/hello', (ctx) => {
  ctx.body = 'Hello World!';
});
// Store route information
routeList.push({ path: '/hello', method: 'GET' });

router.post('/echo', (ctx) => {
  ctx.body = ctx.request.body;
});
// Store route information
routeList.push({ path: '/echo', method: 'POST' });

app.use(router.routes());
app.use(router.allowedMethods());

// Function to retrieve route list
function getRoutes() {
  return routeList;
}

console.log(getRoutes());  // This function now returns all route information

Method Two: Using koa-router's router.stack

If you prefer not to manually manage the route list, koa-router internally uses router.stack to store route information. You can leverage this property to retrieve route information.

javascript
const Koa = require('koa');
const Router = require('@koa/router');

const app = new Koa();
const router = new Router();

router.get('/hello', (ctx) => {
  ctx.body = 'Hello World!';
});

router.post('/echo', (ctx) => {
  ctx.body = ctx.request.body;
});

app.use(router.routes());
app.use(router.allowedMethods());

// Retrieve route information via router.stack
function getRoutes() {
    return router.stack.map((layer) => {
        return {
            path: layer.path,
            method: layer.methods.filter((method) => method !== 'HEAD' && method !== 'OPTIONS'),
        };
    });
}

console.log(getRoutes()); // Output all registered routes

Conclusion

Both methods have their pros and cons. Manually storing route information gives you full control over the format and timing of the stored data, whereas using router.stack relies on koa-router's internal implementation but automatically retrieves all registered route information. You can choose the appropriate method based on your specific requirements.