Generated client reference

Client-onlyReleased · Preview

Add a generated client route reference to your React app.

BTST turns registered client routes into a navigable reference with paths, parameters, sitemap context, and resolved application links.

Best for

Teams that want route paths, parameters, sitemap entries, and navigation context visible inside a development or protected application surface.

Requires
Registered BTST client routes to inspect
External service boundary
None required
Ownership boundary
The reference is derived from your registered client stack and served by your app. You control which routes exist, who can see the page, and whether to eject its UI.
Install Route Docs from the implementation guideView source (opens in a new tab)
Real BTST Route Docs page generated from the client stack, with registered plugin routes, paths, and parameter context.
Route Docs derives its reference from the application's registered client plugins rather than a separate hand-maintained route inventory.

BTST supplies

  • A generated route-reference page for registered BTST client plugins
  • Route paths, path and query parameters, sitemap entries, and plugin context
  • Parameter-aware navigation to routes in the adopter's application
  • An ejectable Route Docs page over the packaged introspection runtime

You supply

  • Registered BTST client plugins whose routes can be inspected
  • A deployment-level access boundary when route details should be private
  • Concrete parameter values before navigating to a dynamic route
  • The application shell and resolved site location

You own and customize

The reference is derived from your registered client stack and served by your app. You control which routes exist, who can see the page, and whether to eject its UI.

Compatibility and dependencies

Maintained integrations
Next.js 15+ App Router · React Router v7 · TanStack Start
Requires
Registered BTST client routes to inspect
External services
None required

From registration to result

The shipped workflow

This is the feature path BTST supplies—not a claim that your app needs no integration work.

  1. Register routes

    Compose the client plugins whose route definitions should appear.

  2. Inspect

    Read route paths, typed parameters, metadata, and sitemap declarations.

  3. Generate

    Render the route inventory with its owning plugin and dynamic context.

  4. Navigate

    Supply concrete parameters and open a resolved route in your application.

Continue your task

Move from evaluation to the right implementation boundary.

Install Route Docs from the implementation guideCompare client route navigation with OpenAPI backend contracts