Skip to content

Releases

RouteCheck 0.3.1

Choose a tag to compare

@github-actions github-actions released this 18 Nov 20:44
dotnet tool update --global RouteCheck --version 0.3.1

Enhancements

  • Add net11.0 to target frameworks

Commits: v0.3.0...v0.3.1

RouteCheck 0.3.0

Choose a tag to compare

@github-actions github-actions released this 14 Nov 17:48
dotnet tool update --global RouteCheck --version 0.3.0

Enhancements

  • RouteCheck now reports ambiguous routes: routes with the same method that match the same requests, e.g. GET /pets/{id} and GET /pets/{name}, which fail at runtime with an AmbiguousMatchException. They are listed below the routes, and as problems in --output json/markdown.
  • New --strict option to exit with code 2 if there are problems with the routes, e.g. in CI jobs.
  • New Auth column (and auth in --output json/markdown): who may request the route, e.g. Anonymous, Authenticated, Policy: Admin or Roles: admin, editor. It includes the fallback policy and global MVC AuthorizeFilters, and is left out if anyone may request every route.
  • New --anonymous option to show only the routes anyone may request.
  • New --verbose option to show more about each route: its name, tags, accepted content types and responses.
  • New -e|--environment option to run the web app in another environment than Development, e.g. -e Staging. It wins over the launch profile.
  • New -c|--configuration option to build and run another configuration than Debug, e.g. -c Release.
  • New --launch-profile option to run the web app with a launch profile of launchSettings.json.
  • New --no-build option to skip the build, e.g. in CI jobs that built the app already.
  • New --handler option to show only routes whose handler contains the given text or matches a wildcard pattern, e.g. --handler "OrdersController.*".
  • New -x|--exclude option to leave out routes whose path contains the given text or matches a wildcard pattern, e.g. -x "/_framework/*".
  • New --baseline option to compare the routes with a document written earlier with --output json, showing the added, removed and changed routes. With --strict, removed routes exit with code 2.
  • F# (*.fsproj) and Visual Basic (*.vbproj) projects are supported. Lambdas in F# are shown as Program (lambda) too.
  • RouteCheck can be run from a directory with a solution (*.sln or *.slnx), e.g. the root of a repository, and --path can be a solution. It uses the solution's web project.
  • Unexpected errors, e.g. when dotnet is not on the PATH, are reported like other errors, so --output json/markdown always print a document.

Bug fixes

  • Hosted services of the web app, e.g. a BackgroundService consuming a queue or sending emails, are no longer started. Before, they ran and did their work while RouteCheck read the routes.

Commits: v0.2.2...v0.3.0

RouteCheck 0.2.2

Choose a tag to compare

@github-actions github-actions released this 08 Nov 13:10
dotnet tool update --global RouteCheck --version 0.2.2

Enhancements

  • New --framework option to choose the target framework to build and run, e.g. --framework net9.0.

Bug fixes

  • Projects targeting multiple frameworks can now be checked, using --framework. Before, RouteCheck could not run them.
  • Controllers with conventional routes (MapControllerRoute) are now shown with their real paths, e.g. /Home/About/{id?}. Before, every action showed the route template, and there was an extra row for an endpoint that only generates links.

Commits: v0.2.1...v0.2.2

RouteCheck 0.2.1

Choose a tag to compare

@github-actions github-actions released this 19 Oct 18:41
dotnet tool update --global RouteCheck --version 0.2.1

Enhancements

  • The routes table no longer has a border.

Commits: v0.2.0...v0.2.1

RouteCheck 0.2.0

Choose a tag to compare

@github-actions github-actions released this 19 Oct 18:28
dotnet tool update --global RouteCheck --version 0.2.0

Enhancements

  • RouteCheck now reads the routes from the app itself instead of its OpenAPI document. It shows all endpoints: minimal APIs, controllers, Razor Pages and everything else mapped as an endpoint. The Microsoft.AspNetCore.OpenApi package is no longer needed.
  • New Handler column (and handler in --output json/markdown), e.g. OrdersController.Get, Page /Orders/Details or Program (lambda).
  • Routes accepting any HTTP method, like Razor Pages, are shown as ANY, and are included for every --method.
  • The app no longer listens on a port, and is stopped as soon as its routes are read. A startup hook replaces the web server; startup hooks already set in DOTNET_STARTUP_HOOKS are kept.
  • --openapi-endpoint is no longer needed and is ignored. It is still accepted, so existing scripts keep working.

Commits: v0.1.0...v0.2.0

RouteCheck 0.1.0

Choose a tag to compare

@github-actions github-actions released this 18 Oct 19:08
dotnet tool update --global RouteCheck --version 0.1.0

Enhancements

  • The routes are sorted by path, and routes with the same path by method (GET, POST, PUT, PATCH, DELETE, ...).
  • New -m|--method option to show only routes with the given HTTP methods, e.g. -m get,post.
  • New -f|--filter option to show only routes whose path contains the given text, or matches a wildcard pattern (* or %), e.g. -f "/pets*".
  • New --output option (table, json or markdown). With json and markdown, only the result is printed, as one document, so RouteCheck works well in scripts, CI jobs and with LLM agents. Errors are part of the document.
  • Shows "No routes found." instead of an empty table.
  • The web app is now built before it is started, and build errors are shown. The startup timeout no longer includes the build.
  • New --timeout option for the seconds to wait for the web app to start (default 20).
  • --path can now also be a project file. RouteCheck looks for a *.csproj file instead of Program.cs, so projects with their entry point in another file work too. If a directory contains several project files, RouteCheck lists them.
  • The web app is started in the Development environment, so the OpenAPI endpoint is available without a launch profile. A launch profile or ASPNETCORE_ENVIRONMENT still takes precedence.
  • Clear error messages when the OpenAPI endpoint is missing (with a hint about AddOpenApi() and MapOpenApi()), fails or returns no OpenAPI document.
  • The option --openApiEndpoint is now called --openapi-endpoint. The old name still works.
  • When the web app exits before it is ready, the error now shows its last output lines, e.g. the exception it crashed with.
  • Ctrl+C cancels the check and stops the started web app.
  • GitHub releases now take their notes from this changelog.

Bug fixes

  • The started web app is now stopped reliably. Before, only the dotnet run process was killed, so the web app itself kept running, also after errors.
  • The web app's output is now read continuously, so a web app that logs a lot no longer blocks during startup.
  • The exit code is now 0 on success and 1 on errors. Before, a successful check returned 1 and errors -1.
  • RouteCheck no longer fails when offline or when nuget.org is unreachable. The update check is skipped after at most 3 seconds.
  • The update check now finds the latest version regardless of the order the feed returns them in.
  • The update check now knows the installed version. Before, released packages reported 1.0.0 internally, so no update was ever shown.
  • Paths containing [ or ] no longer crash RouteCheck.

Commits: v0.0.3...v0.1.0

Release v0.0.3

Choose a tag to compare

@eisnstein eisnstein released this 20 Nov 20:24

Enhancements

  • Add self version check
  • Add test setup

Release v0.0.2

Choose a tag to compare

@eisnstein eisnstein released this 17 Nov 19:49

Enhancements

  • Add path option to be able to give an absolute or relative path to the web app
  • Add openApiEndpoint option to be able to set a custom endpoint