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

Docs: Add API documentation generation #32

Closed
skynetcap opened this issue Jun 23, 2022 · 2 comments
Closed

Docs: Add API documentation generation #32

skynetcap opened this issue Jun 23, 2022 · 2 comments
Labels
enhancement New feature or request good first issue Good for newcomers

Comments

@skynetcap
Copy link
Owner

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 skynetcap added enhancement New feature or request good first issue Good for newcomers labels Jun 23, 2022
@skynetcap
Copy link
Owner Author

Update:

@skynetcap
Copy link
Owner Author

The 4 resources I linked produce Swagger UIs and other HTML output, which isn't what is wanted (at least yet).

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request good first issue Good for newcomers
Projects
None yet
Development

No branches or pull requests

1 participant