search

stoicflame / enunciate

Build-time enhancement tool for Java-based Web services projects
http://enunciate.webcohesion.com/
Other
481 stars 201 forks source link

support for large-scale api documentation #860

Open shahamit opened 6 years ago

shahamit commented 6 years ago

We plan to use the latest version of enunciate for generating documentation for our jax-rs based rest api's. Currently we have over 1110 classes/methods annotated with javax.ws.rs.Path annotation (and this count would just increase over time). This leads to an api catalog (home page) that has huge number of api paths listed. It becomes difficult to browse and search through the api that the user is looking for. I am not sure if the browser load time would also slow down. Are there out of the box alternatives to this problem?

One solution could be that for the generated web page (index.html) to support pagination and a search bar (with suggestive search) that searches api paths across pages.

Thoughts?

Thanks.

stoicflame commented 6 years ago

Sounds like a great feature. It's probably not something I'd pick up unless there was additional demand for it or someone wanted to sponsor the work.

I'll mark this issue as "seeking sponsor" and keep it open for additional upvotes.

shahamit commented 6 years ago

Can these changes be implemented by modifying the freemarker template or would it need code changes?

stoicflame commented 6 years ago

I'm pretty sure it would just be a new freemarker template.