way to get a list of registered services

[dw-rs]

it doesn't currently look like there is a good way to get a list of registered services/endpoints.
such functionality would be useful for creating index sites that list all endpoints (my usecase).

[Chaostheorie]

Just my 2cts, but consider looking into the paperclip project, because they had to solve a similar problem in the past. There arguably should be a way to inspect the App instance anyway, since paperclip AFAIK achieves this by using codegen on the routes and related structs.

[sagoez]

Are there any plans to move this forward? I could take a look at it if wanted.

[douggynix]

@samgj18 That would be great. Most legacy web containers like Tomcat or SpringBoot WebMVC provides a way to log all the endpoints exposed by their web framework. I think this feature is a minimal must for Actix Web as a regard to its usage to provide.

It will make developers life easier to debug and troubleshoot unreachable endpoints if that can be achieved.

This issue has been opened more than 2 years and a month. I hope it can be adressed in next or future release of Actix. Thanks for this great framework

[robjtede]

It's not high up my personal priority list, but I'm open to proposals on how to achieve this. I would certainly like to see a high level plan in this issue before we start working on a PR though.

[sagoez]

I’ll take a look at this and come up with a proposal as soon as I have some time 😄. But if anyone comes with a proposal before me feel free to do so and work on it.

[ayamdobhal]

From what I understand, we're looking at a way to list all of the endpoints right? What I would propose is we could have a new module to store the endpoint details and collect those during the app initialization and then simply adding an endpoint to return those details as JSON. I don't think that would break any existing code and the struct storing the data could be under an Arc<Mutex<Struct>> to ensure thread safety. All of this could be optional (maybe under a feature flag but i guess that would be an overkill?) and the user would have the option to include the endpoint when they're creating the app. Let me know if that works and I could make a PR.

[douggynix]

I think that can be a good start. And it would be good to have a flag to tell it to list those endpoints during actix web server startup into the console output through

tracing::info!( "{} {} ", http_method, endpoint);

[ayamdobhal]

Alright I'll see if I can take this over this weekend. Gonna be moving so might have to push this to next week but would be happy to make a PR.
Can someone assign this to me?

[dertin]

Hey team,

Could you please take a look at PR #3594? This is our first approach, and I'd appreciate your review and feedback.

Thanks!