Modify

Ticket #28 (new enhancement)

Opened 4 years ago

Last modified 3 years ago

Ability to dump routing structure

Reported by: bruno Owned by: bruno
Priority: minor Milestone: 0.5
Component: modules/kauri-routing Version: trunk
Keywords: Cc:

Description

It would be interesting if Kauri could dump the request-routing structure.

Reasons why this is useful:

  • parts of the routing are not explicitly described but created by auto-scanning: e.g. JAX-RS and possibly the upcoming database resources
  • it can help new users to get insight into Kauri
  • when you get introduced to a Kauri system of which you have no previous knowledge, it helps to give a quick understanding of the system without the need to look into the sources.
  • others?

This means that the restservices exported by the modules should not be opaque entities to which you can send request, but that they would also be able to describe themselves (= reflection).

Restservices which can provide this information could do so by implementing an optional interface, like 'InspectableRestservice'. For the data returned from this service, multiple approaches can be taken:

  • something which matches WADL (this would work especially well with JAX-RS)
  • something which doesn't impose too much structure, having the advantage that more specific routing details can be included (e.g. type of router, routing patterns which are not URI templates, ...)

As for reporting the routing structure, there are various possibilities (besides using the API):

  • a simple command line '--dump-routing' option which prints the structure to standard output upon Kauri startup
  • a module which provides XML and HTML views on the data.

Attachments

Change History

comment:1 Changed 4 years ago by bruno

  • Type changed from defect to enhancement

comment:2 Changed 3 years ago by mpo

  • Milestone set to 0.5
View

Add a comment

Modify Ticket

Action
as new
Author


E-mail address and user name can be saved in the Preferences.

 
Note: See TracTickets for help on using tickets.