Skip to content
GitLab
Projects Groups Snippets
  • /
  • Help
    • Help
    • Support
    • Community forum
    • Submit feedback
    • Contribute to GitLab
  • Sign in / Register
  • O openapi-generator
  • Project information
    • Project information
    • Activity
    • Labels
    • Members
  • Repository
    • Repository
    • Files
    • Commits
    • Branches
    • Tags
    • Contributors
    • Graph
    • Compare
  • Issues 3,476
    • Issues 3,476
    • List
    • Boards
    • Service Desk
    • Milestones
  • Merge requests 402
    • Merge requests 402
  • CI/CD
    • CI/CD
    • Pipelines
    • Jobs
    • Schedules
  • Deployments
    • Deployments
    • Environments
    • Releases
  • Packages and registries
    • Packages and registries
    • Package Registry
    • Infrastructure Registry
  • Monitor
    • Monitor
    • Incidents
  • Analytics
    • Analytics
    • Value stream
    • CI/CD
    • Repository
  • Wiki
    • Wiki
  • Snippets
    • Snippets
  • Activity
  • Graph
  • Create a new issue
  • Jobs
  • Commits
  • Issue Boards
Collapse sidebar
  • OpenAPI Tools
  • openapi-generator
  • Issues
  • #13027
Closed
Open
Issue created Jul 27, 2022 by Administrator@rootContributor

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

Created by: hhovhann

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

Assignee
Assign to
Time tracking