Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

support for large-scale api documentation #860

Open
shahamit opened this issue May 8, 2018 · 3 comments
Open

support for large-scale api documentation #860

shahamit opened this issue May 8, 2018 · 3 comments

Comments

@shahamit
Copy link

shahamit commented May 8, 2018

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
Copy link
Owner

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.

@stoicflame stoicflame changed the title Paginated documentation with an ability to search support for large-scale api documentation May 8, 2018
@shahamit
Copy link
Author

shahamit commented May 9, 2018

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

@stoicflame
Copy link
Owner

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants