How to walk routing

[JonathanCabezas]

Hello,

I've tried to walk the routing object, as you do to generate the documentation, but walkRouting is not exposed, AbstractEndpoint neither. It makes it pretty hard to reproduce this. How would you go about it ?

My 2 usages are:

1. To write a test to verify that my documentation has the right number of expected routes
2. I want to generate a ts file to have autocomplete on my routes

For usage 2, do you see another way to do this ?

I already tried with static type analysis, using NestedKeyOf but my ts server was getting awfully slow for autocomplete.

[JonathanCabezas]

Here's what I came up with to count routes:

import { DependsOnMethod, Routing } from "express-zod-api";

const countNbEndpoints = (obj: Routing) => {
  let nbEndpoints = 0;
  const keys = Object.keys(obj);

  // ENDPOINT LEAF
  if (keys.length === 0) {
    return 1;
  }

  keys.forEach(key => {
    const value = obj[key];

    // DEPENDS ON METHOD LEAF
    if (value instanceof DependsOnMethod) {
      nbEndpoints += value.entries.length;
      return;
    }

    // NODE
    if (typeof value === "object" && value !== null) {
      nbEndpoints += countNbEndpoints(value as Routing);
    }
  });

  return nbEndpoints;
};

I'm not using StaticServe for now.

[RobinTail]

To write a test to verify that my documentation has the right number of expected routes
I want to generate a ts file to have autocomplete on my routes

How about this, @JonathanCabezas ?

const documentation = new Documentation({
  routing,
  config,
  version: "1.2.3",
  title: "Example API",
  serverUrl: "https://example.com",
});

console.log(
  Object.keys(documentation.rootDoc.paths!)
);