{"id":16000972,"url":"https://github.com/makspll/Pathfinder","last_synced_at":"2025-10-21T06:30:53.255Z","repository":{"id":257483970,"uuid":"853870283","full_name":"makspll/Pathfinder","owner":"makspll","description":"Endpoint discovery tool for .NET core and .NET Framework web projects","archived":false,"fork":false,"pushed_at":"2024-11-12T18:09:33.000Z","size":1631,"stargazers_count":3,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-01-28T11:37:50.765Z","etag":null,"topics":["dotnet","dotnet-core","dotnet-framework","dotnet-web","endpoint","route-discovery","security-tools","static-analysis","web"],"latest_commit_sha":null,"homepage":"","language":"C#","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/makspll.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2024-09-07T19:03:24.000Z","updated_at":"2024-11-26T12:41:32.000Z","dependencies_parsed_at":null,"dependency_job_id":"6a4b3d6c-f758-41f6-bf76-a7b9ab7ffd18","html_url":"https://github.com/makspll/Pathfinder","commit_stats":null,"previous_names":["makspll/reflection-utils","makspll/dotnet-pathfinder","makspll/pathfinder"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/makspll%2FPathfinder","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/makspll%2FPathfinder/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/makspll%2FPathfinder/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/makspll%2FPathfinder/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/makspll","download_url":"https://codeload.github.com/makspll/Pathfinder/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":237441176,"owners_count":19310578,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["dotnet","dotnet-core","dotnet-framework","dotnet-web","endpoint","route-discovery","security-tools","static-analysis","web"],"created_at":"2024-10-08T09:21:20.015Z","updated_at":"2025-10-21T06:30:47.797Z","avatar_url":"https://github.com/makspll.png","language":"C#","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Pathfinder\n\u003cp align=\"center\"\u003e\n    \u003cimg src=\"https://i.imgur.com/TEDoP2L.jpeg\" alt=\"Pathfinder\" width=\"300\"/\u003e\n\u003c/p\u003e\n\nFinds and outputs all API routes found in a .NET assembly in textual or JSON format.\n\n## Features\n- Attribute based routing\n- Conventional routing (templates + defaults have to be specified in a config file)\n- .NET core support\n- .NET framework support\n- JSON and Text output\n- Configurable backing lib for projects with custom routing mechanisms\n- Customizable template based report generation (see [report for assemblies in /test_assemblies](https://makspll.github.io/Pathfinder/))\n\n# Installation\n\n## Prerequisites\n- .NET 7 or later installed (only for running CLI, not in your project)\n\n## CLI\n- `dotnet tool install -g Makspll.Pathfinder`\n\n# Usage\nRun `pathfinder help` to see all available arguments\n\n## Analysis\nYou can find all available routes in your assemblies using the `analyze` command: \n\n```\npathfinder analyze **/bin/**/yourdllname.dll\n```\n\n![image](https://i.imgur.com/2Oz4HJA.png)\n\n## Report\nYou can also generate a report based on the analysis using the `report` command:\n\n```\npathfinder report **/bin/**/yourdllname.dll\n```\n\n![image](https://i.imgur.com/CLpUY3W.png)\n\n\n# Configuration\n\n## Config file\nThe 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.\n\nCurrently the file needs to specify all your conventional routing configuration (anything that isn't attribute based).\n\n### .NET framework\nIn .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.\n\nNote 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.\n\n```json\n{\n    \"ConventionalRoutes\": [\n        {\n            \"Template\": \"conventionalprefix/{controller}/{action}\",\n            \"Type\": \"MVC\"\n        },\n        {\n            \"Template\": \"conventionalprefix2/{controller}\",\n            \"Defaults\": {\n                \"action\": \"DefaultAction\"\n            },\n            \"Type\": \"MVC\"\n        },\n        {\n            \"Template\": \"conventionalwithnoactionspecs\",\n            \"Defaults\": {\n                \"controller\": \"DefaultConventional\",\n                \"action\": \"DefaultAction\"\n            },\n            \"Type\": \"MVC\"\n        },\n        {\n            \"Template\": \"apiconventionalprefix/{controller}/{action}\",\n            \"Type\": \"API\"\n        },\n        {\n            \"Template\": \"apiconventionalprefix2/{controller}\",\n            \"Defaults\": {\n                \"action\": \"DefaultAction\"\n            },\n            \"Type\": \"API\"\n        },\n        {\n            \"Template\": \"apiconventionalwithnoactionspecs\",\n            \"Defaults\": {\n                \"controller\": \"ApiDefaultConventionalApi\",\n                \"action\": \"DefaultAction\"\n            },\n            \"Type\": \"API\"\n        }\n    ]\n}\n```\n\n### .NET core\n\n.NET core does not make such a distinction, you shouldn't specify the type of controller:\n\n```json\n{\n    \"ConventionalRoutes\": [\n        {\n            \"Template\": \"conventionalprefix/{controller}/{action}\"\n        },\n        {\n            \"Template\": \"conventionalprefix2/{controller}\",\n            \"Defaults\": {\n                \"action\": \"DefaultAction\"\n            }\n        },\n        {\n            \"Template\": \"conventionalwithnoactionspecs\",\n            \"Defaults\": {\n                \"controller\": \"DefaultConventional\",\n                \"action\": \"DefaultAction\"\n            }\n        }\n    ]\n}\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmakspll%2FPathfinder","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmakspll%2FPathfinder","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmakspll%2FPathfinder/lists"}