Repository navigation
Releases
Releases · eisnstein/RouteCheck
RouteCheck 0.3.1
dotnet tool update --global RouteCheck --version 0.3.1Enhancements
- Add
net11.0to target frameworks
Commits: v0.3.0...v0.3.1
RouteCheck 0.3.0
dotnet tool update --global RouteCheck --version 0.3.0Enhancements
- RouteCheck now reports ambiguous routes: routes with the same method that match the same requests, e.g.
GET /pets/{id}andGET /pets/{name}, which fail at runtime with anAmbiguousMatchException. They are listed below the routes, and asproblemsin--output json/markdown. - New
--strictoption to exit with code2if there are problems with the routes, e.g. in CI jobs. - New Auth column (and
authin--output json/markdown): who may request the route, e.g.Anonymous,Authenticated,Policy: AdminorRoles: admin, editor. It includes the fallback policy and global MVCAuthorizeFilters, and is left out if anyone may request every route. - New
--anonymousoption to show only the routes anyone may request. - New
--verboseoption to show more about each route: its name, tags, accepted content types and responses. - New
-e|--environmentoption to run the web app in another environment thanDevelopment, e.g.-e Staging. It wins over the launch profile. - New
-c|--configurationoption to build and run another configuration thanDebug, e.g.-c Release. - New
--launch-profileoption to run the web app with a launch profile oflaunchSettings.json. - New
--no-buildoption to skip the build, e.g. in CI jobs that built the app already. - New
--handleroption to show only routes whose handler contains the given text or matches a wildcard pattern, e.g.--handler "OrdersController.*". - New
-x|--excludeoption to leave out routes whose path contains the given text or matches a wildcard pattern, e.g.-x "/_framework/*". - New
--baselineoption 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 code2. - F# (
*.fsproj) and Visual Basic (*.vbproj) projects are supported. Lambdas in F# are shown asProgram (lambda)too. - RouteCheck can be run from a directory with a solution (
*.slnor*.slnx), e.g. the root of a repository, and--pathcan be a solution. It uses the solution's web project. - Unexpected errors, e.g. when
dotnetis not on the PATH, are reported like other errors, so--output json/markdownalways print a document.
Bug fixes
- Hosted services of the web app, e.g. a
BackgroundServiceconsuming 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
dotnet tool update --global RouteCheck --version 0.2.2Enhancements
- New
--frameworkoption 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
dotnet tool update --global RouteCheck --version 0.2.1Enhancements
- The routes table no longer has a border.
Commits: v0.2.0...v0.2.1
RouteCheck 0.2.0
dotnet tool update --global RouteCheck --version 0.2.0Enhancements
- 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.OpenApipackage is no longer needed. - New Handler column (and
handlerin--output json/markdown), e.g.OrdersController.Get,Page /Orders/DetailsorProgram (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_HOOKSare kept. --openapi-endpointis 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
dotnet tool update --global RouteCheck --version 0.1.0Enhancements
- The routes are sorted by path, and routes with the same path by method (GET, POST, PUT, PATCH, DELETE, ...).
- New
-m|--methodoption to show only routes with the given HTTP methods, e.g.-m get,post. - New
-f|--filteroption to show only routes whose path contains the given text, or matches a wildcard pattern (*or%), e.g.-f "/pets*". - New
--outputoption (table,jsonormarkdown). Withjsonandmarkdown, 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
--timeoutoption for the seconds to wait for the web app to start (default 20). --pathcan now also be a project file. RouteCheck looks for a*.csprojfile instead ofProgram.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
Developmentenvironment, so the OpenAPI endpoint is available without a launch profile. A launch profile orASPNETCORE_ENVIRONMENTstill takes precedence. - Clear error messages when the OpenAPI endpoint is missing (with a hint about
AddOpenApi()andMapOpenApi()), fails or returns no OpenAPI document. - The option
--openApiEndpointis 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 runprocess 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
0on success and1on errors. Before, a successful check returned1and 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.0internally, so no update was ever shown. - Paths containing
[or]no longer crash RouteCheck.
Commits: v0.0.3...v0.1.0
Release v0.0.3
Enhancements
- Add self version check
- Add test setup
Release v0.0.2
Enhancements
- Add
pathoption to be able to give an absolute or relative path to the web app - Add
openApiEndpointoption to be able to set a custom endpoint