Interfaces

Project

RouteVisualizer

NuGet packageOwin.Framework.RouteVisualizer
GitHub sourceOwinFramework.RouteVisualizer

Home |  Readme

Responds with an SVG drawing of all middleware components configured in the Owin pipeline. If these middleware implement ISelfDocumenting or IAnalysable then this information will be included on the drawing

This middleware will produce an SVG drawing of the Owin Pipeline. The drawing shows all of the routes and middleware that runs on each route. If middleware exposes analytics then these are also shown on the drawing.

Adding this middleware to the Owin pipeline

 builder.Register(ninject.Get<OwinFramework.RouteVisualizer.RouteVisualizerMiddleware>())
    .As("Route visualizer")
    .ConfigureWith(config, "/owinFramework/middleware/routeVisualizer");    
The assumes that you are using Ninject as your IoC container, and followed the getting started walkthrough. If this is not the case then you will need to adjust the code to work in your application.

Default Configuration

The configuration below is the configuration you will get by default if you do not provide a configuration for this middleware.

{
   "owinFramework": {
      "middleware": {
         "routeVisualizer": {
            "documentationRootUrl": "/owin/visualization/docs/configuration",
            "path": "/owin/visualization",
            "enabled": true,
            "analyticsEnabled": false
         }
      }
   }
}

Configuration notes

  • You can set the documentationRootUrl to null or empty to disable this documentation in your production environment.
  • In your production environment you probably want to turn off the route visualizer or place it on a route where authorization is required.