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

Question: Best way to document and generate HTML based on OpenAPI annotations programmatically #13027

Open
hhovhann opened this issue Jul 27, 2022 · 0 comments
Labels
Announcement Project/release related announcements

Comments

@hhovhann
Copy link

hhovhann commented Jul 27, 2022

Dear all, first of all, many thanks for the nice and helpful tool that you are made.

SITUATION: We need to add API documentation in our project and need to generate that based on only code (if that allows the plugin).

TASK: Generate HTML or PDF API documentation in mvn verify phase based on existing controller code based on openapi annotations springdoc rescource.

ACTIONS: We are using now springdoc-openapi + openapi-generator-maven-plugin pair. After running the instance plugin generates YAML file based on the documents annotations code that could be downloaded and used as a path in the plugin configuration
<inputSpec>${project.basedir}/src/main/resources/static/api.yaml</inputSpec>

RESULT: As a result I was able to get HTML but just based on the existing YAML file.

QUESTION: Is there any better way to generate HTML or pdf (I think you don't have yet a proper generator to support that format yet), just based on code that had the same generated HTML as we had when using the YAML file.

Thanks in advance

@hhovhann hhovhann added the Announcement Project/release related announcements label Jul 27, 2022
@hhovhann hhovhann changed the title Question: How to generate html/html2/dynamic-html based on java code Question: Best way to document and generate HTML based on OpenAPI annotations programatically Jul 31, 2022
@hhovhann hhovhann changed the title Question: Best way to document and generate HTML based on OpenAPI annotations programatically Question: Best way to document and generate HTML based on OpenAPI annotations programmatically Jul 31, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Announcement Project/release related announcements
Projects
None yet
Development

No branches or pull requests

1 participant