gofasta routes

Statically parses your project’s route files and prints every registered REST route as a table: HTTP method, the full path including the mounted API prefix, and the file the registration lives in.

The command never imports or runs your code. It is a parse-and-format pass over the route files, so it needs no database, no Redis, and no running server.

Usage

gofasta routes

Run it from the root of a Gofasta project. The command takes no flags of its own; the root command’s global flags — notably --json — apply.

Example

For a freshly scaffolded project with one generated User resource:

$ gofasta routes
METHOD   PATH                  FILE
GET      /health               index.routes.go
GET      /health/live          index.routes.go
GET      /health/ready         index.routes.go
GET      /swagger/*            index.routes.go
GET      /api/v1/users         user.routes.go
POST     /api/v1/users         user.routes.go
GET      /api/v1/users/{id}    user.routes.go
PUT      /api/v1/users/{id}    user.routes.go
DELETE   /api/v1/users/{id}    user.routes.go

Paths use chi’s pattern syntax, so URL parameters appear as {id} — exactly as written in the route file.

What it parses

Routes registered in index.routes.go itself — the health probes, the WebSocket upgrade endpoint, the Swagger UI — print without the API prefix, because they are mounted on the root router rather than inside the /api/v1 subrouter.

The scan is layout-aware. In the layered layout it reads app/rest/routes/*.routes.go; in the feature-package layout it reads the per-resource route files that gofasta refactor produces.

JSON output

--json emits an array — always an array, empty when nothing matched — with a stable field shape:

$ gofasta routes --json
[
  { "method": "GET", "path": "/api/v1/users", "file": "user.routes.go" },
  { "method": "POST", "path": "/api/v1/users", "file": "user.routes.go" },
  { "method": "GET", "path": "/api/v1/users/{id}", "file": "user.routes.go" }
]

This is the contract agents and CI steps read. The text table above it is for humans and may be reformatted in a future release; the JSON field names will not change.

Using it in CI

The output is deterministic, so gofasta routes --json works as an API-surface snapshot. Commit it and diff in CI to catch a route that was added, removed, or silently re-pathed:

gofasta routes --json > .api-surface.json
git diff --exit-code .api-surface.json

Errors

See Error codes for the full list.

Limitations

Static parsing means routes registered dynamically — built from a slice at runtime, or wrapped in a helper that hides the chi call — are not detected, because rows come from matching the chi method-call form directly. GraphQL operations are not routes in this sense; use the /graphql-playground endpoint to introspect the schema instead.