[fj-doc-maven-plugin] goal init,

added openapi documentation for flavour 'springboot-3'

Author: fugerit79

CHANGELOG.md

@@ -9,6 +9,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ### Changed
 
+- [fj-doc-maven-plugin] goal init, added openapi documentation for flavour 'springboot-3'
 - [fj-doc-playground-quarkus] added venus version 8.8.1 and 8.8.2 to doc project init
 
 ## [8.8.2] - 2024-09-10

fj-doc-maven-plugin/src/main/resources/config/template/flavour/flavour-macro.ftl

@@ -31,7 +31,7 @@
     @APIResponse(responseCode = "200", description = "The ${outputDescription} document content" )
     @APIResponse(responseCode = "500", description = "In case of an unexpected error" )
     @Tags( { @Tag( name = "document" ), @Tag( name = "${outputDescription?lower_case}" ) } )
-    @Operation( operationId = "${outputDescription}Example", summary =  "Generated an example ${outputDescription} document using Fugerit Venus Doc handler" )
+    @Operation( operationId = "${outputDescription}Example", summary =  "Generates an example ${outputDescription} document using Fugerit Venus Doc handler" )
     @GET
     @Produces("${outputMime}")
     @Path("/example.${outputExtension}")
@@ -43,7 +43,14 @@
     <@createPathMethod context=context outputMime=outputMime outputExtension=outputExtension outputDescription=outputDescription/>
 </#macro>
 
+<#-- using https://javadoc.io/doc/io.swagger.core.v3/swagger-annotations/latest/index.html -->
 <#macro createSpringBootPath context outputMime outputExtension outputDescription>
+    @Operation( method = "GET", operationId = "${outputDescription}Example", tags = { "document", "${outputDescription?lower_case}" },
+        summary = "Generates an example ${outputDescription} document using Fugerit Venus Doc handler" )
+    @ApiResponses(value = {
+        @ApiResponse(responseCode = "200", description = "The ${outputDescription} document content", content = { @Content(mediaType = "${outputMime}") } ),
+        @ApiResponse(responseCode = "500", description = "In case of an unexpected error" )
+    })
     @GetMapping(value = "/example.${outputExtension}", produces = "${outputMime}" )
     <@createPathMethod context=context outputMime=outputMime outputExtension=outputExtension outputDescription=outputDescription/>
 </#macro>

fj-doc-maven-plugin/src/main/resources/config/template/flavour/springboot-3/DocController.ftl

@@ -13,6 +13,11 @@ import org.springframework.web.bind.annotation.GetMapping;
 import org.springframework.web.bind.annotation.RequestMapping;
 import org.springframework.web.bind.annotation.RestController;
 
+import io.swagger.v3.oas.annotations.Operation;
+import io.swagger.v3.oas.annotations.responses.ApiResponses;
+import io.swagger.v3.oas.annotations.responses.ApiResponse;
+import io.swagger.v3.oas.annotations.media.Content;
+
 import lombok.extern.slf4j.Slf4j;
 
 @RestController