[NIFI-9630] Migrate NiFi Registry to swagger-codegen-maven-plugin

• Type: Improvement
• Status: Resolved
• Priority: Minor
• Resolution: Fixed
• Fix Version/s: 1.16.0
• Component/s: NiFi Registry
• Assignee: David Handermann
• Reporter: David Handermann
• Created: 25/Jan/22 19:04
• Updated: 26/Jan/22 14:04
• Resolved: 26/Jan/22 14:04

Description

NiFi Registry REST API documentation uses a combination of the swagger2markup-maven-plugin and the asciidoctor-maven-plugin to generate the REST API documentation HTML for embedding and publication. The Swagger2Markup project is no longer maintained, and the last version was released in 2018. In addition, the transitive dependencies for Swagger2Markup are no available in Maven Central, but can be found in the read-only JCenter repository.

The Swagger Codegen library, and associated Maven plugin, support generating static HTML documentation from Swagger definitions. The library and Maven plugin are actively maintained and provides a replacement for the current REST API documentation approach in NiFi Registry. Although the styling is different than the current approach, the generated HTML contains the same information.

Issue Links

• is required by: NIFI-9624 Remove JCenter Repository References
• links to: GitHub Pull Request #5715