How can i get a list of Koa server url routes

在Koa中，通常我们会使用koa-router这个库来处理路由的相关功能。koa-router提供了灵活的方法来定义路由和执行相应的动作。但是，直接从Koa服务器获取所有注册的路由列表并不是koa-router直接支持的功能。不过，我们可以通过一些方法间接获取到路由列表。

方法一：保存路由定义时的信息

最简单直接的方式是在定义路由时将相关信息存储起来。这样，你可以随时访问这个存储来获取当前的路由列表。

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

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

// 创建一个数组来保存路由信息
const routeList = [];

router.get('/hello', (ctx) => {
  ctx.body = 'Hello World!';
});
// 保存路由信息
routeList.push({ path: '/hello', method: 'GET' });

router.post('/echo', (ctx) => {
  ctx.body = ctx.request.body;
});
// 保存路由信息
routeList.push({ path: '/echo', method: 'POST' });

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

// 获取路由列表的函数
function getRoutes() {
  return routeList;
}

console.log(getRoutes());  // 现在这个函数会返回所有的路由信息

方法二：使用 koa-router 的 router.stack

如果你不想手动管理路由列表，koa-router 的内部使用了 router.stack 来存储路由信息。你可以利用这个属性来获取路由信息。

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());

// 通过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()); // 输出所有注册的路由

在这个例子中，router.stack 是一个包含所有路由层的数组。每个层都有 path 和 methods 等属性，通过遍历这个数组，我们可以构建出一个包含所有路由信息的列表。

结论

这两种方法各有利弊。手动保存路由信息可以让你完全控制保存的信息的格式和时机，而使用router.stack则依赖于koa-router的内部实现，但能自动获取所有注册的路由信息。你可以根据实际需求选择合适的方法。