Docs: Add API documentation generation
Closed this issue · 2 comments
skynetcap commented
Background:
We need to automatically generate a markdown file that can be viewed on GitHub which describes all exposed APIs. This should occur during the maven build process.
Feature Idea:
Do this during maven build with the right plugins.
Additional Solution Notes:
skynetcap commented
Update:
- https://docs.spring.io/spring-restdocs/docs/current/reference/html5/ describes a spring native (no 3rd party dependencies) doc generation, but only generates HTML it looks like. Probably not worth it to try converting the HTML to markdown somehow, the docs won't update that much. Will just manually update them. Closing.
skynetcap commented
The 4 resources I linked produce Swagger UIs and other HTML output, which isn't what is wanted (at least yet).