👁 Image
Makspll.PathfinderLib 0.4.2

Pathfinder

<p align="center"> <img src="https://i.imgur.com/TEDoP2L.jpeg" alt="Pathfinder" width="300"/> </p>

Finds and outputs all API routes found in a .NET assembly in textual or JSON format.

Features

• Attribute based routing
• Conventional routing (templates + defaults have to be specified in a config file)
• .NET core support
• .NET framework support
• JSON and Text output
• Configurable backing lib for projects with custom routing mechanisms
• Customizable template based report generation (see report for assemblies in /test_assemblies)

Installation

Prerequisites

• .NET 7 or later installed (only for running CLI, not in your project)

CLI

• dotnet tool install -g Makspll.Pathfinder

Usage

Run pathfinder help to see all available arguments

Analysis

You can find all available routes in your assemblies using the analyze command:

pathfinder analyze **/bin/**/yourdllname.dll

👁 image

Report

You can also generate a report based on the analysis using the report command:

pathfinder report **/bin/**/yourdllname.dll

Configuration

Config file

The program is configured via pathfinder.json files found in your project. If the file is not found you can specify a path via the -c flag.

Currently the file needs to specify all your conventional routing configuration (anything that isn't attribute based).

.NET framework

In .NET framework projects, you will need to specify whether each of your routes is an MVC or API route. This is done by adding a Type field to each route in the config file.

Note MVC conventional routes are normally found in App_Start/RouteConfig.cs while WebApi controllers are found in App_Start/WebApiConfig.cs the System.Web.Http namespace corresponds to WebApi controllers while the System.Web.Mvc namespace corresponds to MVC ones.

{
 "ConventionalRoutes": [
 {
 "Template": "conventionalprefix/{controller}/{action}",
 "Type": "MVC"
 },
 {
 "Template": "conventionalprefix2/{controller}",
 "Defaults": {
 "action": "DefaultAction"
 },
 "Type": "MVC"
 },
 {
 "Template": "conventionalwithnoactionspecs",
 "Defaults": {
 "controller": "DefaultConventional",
 "action": "DefaultAction"
 },
 "Type": "MVC"
 },
 {
 "Template": "apiconventionalprefix/{controller}/{action}",
 "Type": "API"
 },
 {
 "Template": "apiconventionalprefix2/{controller}",
 "Defaults": {
 "action": "DefaultAction"
 },
 "Type": "API"
 },
 {
 "Template": "apiconventionalwithnoactionspecs",
 "Defaults": {
 "controller": "ApiDefaultConventionalApi",
 "action": "DefaultAction"
 },
 "Type": "API"
 }
 ]
}

.NET core

.NET core does not make such a distinction, you shouldn't specify the type of controller:

{
 "ConventionalRoutes": [
 {
 "Template": "conventionalprefix/{controller}/{action}"
 },
 {
 "Template": "conventionalprefix2/{controller}",
 "Defaults": {
 "action": "DefaultAction"
 }
 },
 {
 "Template": "conventionalwithnoactionspecs",
 "Defaults": {
 "controller": "DefaultConventional",
 "action": "DefaultAction"
 }
 }
 ]
}