RouteCheck

Check your API routes in your Terminal.

---

RouteCheck is a dotnet tool for checking/viewing your API routes in your terminal. The check command (default) shows you all routes in a nice table with some basic information. RouteCheck basically starts your application and calls the /openapi/v1.json endpoint and displays the returned JSON.

Currently this only works if you are using the Microsoft.AspNetCore.OpenApi package and expose the generated JSON via an endpoint.

Installation

You can install PackCheck as a dotnet tool via NuGet:

# Install
dotnet tool install --global RouteCheck

# Update
dotnet tool update --global RouteCheck

Usage

In your terminal cd into a ASP.NET project and run:

routecheck

This should give you something like this:

You can also provide a path to the web app via the path option:

routecheck --path /absolute/path/to/webapp

# or

routecheck -p relativ/path/to/webapp

If you use a custom OpenApi endpoint, you can set the openApiEndpoint option:

routecheck --openApiEndpoint /some/other/endpoint

For help run:

routecheck -h

LICENSE

MIT