Skip to content

Documentation #3

@mcupak

Description

@mcupak

Create interactive as well as printable documentation based on Swagger.

Steps:

  • Annotate resources with Swagger annotations.
  • Create a maven profile using swagger-maven-plugin to generate swagger.json.
  • Use Swagger UI to display interactive documentation based on swagger.json.
  • Use swagger2markup-maven-plugin to convert output of swagger-maven-plugin to asciidoc.
  • Use asciidoctor-maven-plugin to convert asciidoc to html5 and pdf using the respective backends in the plugin configuration.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions