Skip to content

Commit a3e9d30

Browse files
committed
[fj-doc-maven-plugin] goal init,
added openapi documentation for flavour 'micronaut-4'
1 parent 360955b commit a3e9d30

File tree

3 files changed

+25
-12
lines changed

3 files changed

+25
-12
lines changed

CHANGELOG.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
99

1010
### Changed
1111

12+
- [fj-doc-maven-plugin] goal init, added openapi documentation for flavour 'micronaut-4'
1213
- [fj-doc-maven-plugin] goal init, added openapi documentation for flavour 'springboot-3'
1314
- [fj-doc-playground-quarkus] added venus version 8.8.1 and 8.8.2 to doc project init
1415

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

Lines changed: 15 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -31,26 +31,33 @@
3131
@APIResponse(responseCode = "200", description = "The ${outputDescription} document content" )
3232
@APIResponse(responseCode = "500", description = "In case of an unexpected error" )
3333
@Tags( { @Tag( name = "document" ), @Tag( name = "${outputDescription?lower_case}" ) } )
34-
@Operation( operationId = "${outputDescription}Example", summary = "Generates an example ${outputDescription} document using Fugerit Venus Doc handler" )
34+
@Operation( operationId = "${outputDescription}Example", summary = "Example ${outputDescription} generation",
35+
description = "Generates an example ${outputDescription} document using Fugerit Venus Doc handler" )
3536
@GET
3637
@Produces("${outputMime}")
3738
@Path("/example.${outputExtension}")
3839
<@createPathMethod context=context outputMime=outputMime outputExtension=outputExtension outputDescription=outputDescription/>
3940
</#macro>
4041

41-
<#macro createMicronautPath context outputMime outputExtension outputDescription>
42-
@Get(uri="/example.${outputExtension}", produces="${outputMime}")
43-
<@createPathMethod context=context outputMime=outputMime outputExtension=outputExtension outputDescription=outputDescription/>
44-
</#macro>
45-
4642
<#-- using https://javadoc.io/doc/io.swagger.core.v3/swagger-annotations/latest/index.html -->
47-
<#macro createSpringBootPath context outputMime outputExtension outputDescription>
43+
<#macro createOpenAPIDoc context outputMime outputExtension outputDescription>
4844
@Operation( method = "GET", operationId = "${outputDescription}Example", tags = { "document", "${outputDescription?lower_case}" },
49-
summary = "Generates an example ${outputDescription} document using Fugerit Venus Doc handler" )
45+
summary = "Example ${outputDescription} generation",
46+
description = "Generates an example ${outputDescription} document using Fugerit Venus Doc handler" )
5047
@ApiResponses(value = {
5148
@ApiResponse(responseCode = "200", description = "The ${outputDescription} document content", content = { @Content(mediaType = "${outputMime}") } ),
5249
@ApiResponse(responseCode = "500", description = "In case of an unexpected error" )
5350
})
51+
</#macro>
52+
53+
<#macro createMicronautPath context outputMime outputExtension outputDescription>
54+
<@createOpenAPIDoc context=context outputMime=outputMime outputExtension=outputExtension outputDescription=outputDescription/>
55+
@Get(uri="/example.${outputExtension}", produces="${outputMime}")
56+
<@createPathMethod context=context outputMime=outputMime outputExtension=outputExtension outputDescription=outputDescription/>
57+
</#macro>
58+
59+
<#macro createSpringBootPath context outputMime outputExtension outputDescription>
60+
<@createOpenAPIDoc context=context outputMime=outputMime outputExtension=outputExtension outputDescription=outputDescription/>
5461
@GetMapping(value = "/example.${outputExtension}", produces = "${outputMime}" )
5562
<@createPathMethod context=context outputMime=outputMime outputExtension=outputExtension outputDescription=outputDescription/>
5663
</#macro>

fj-doc-maven-plugin/src/main/resources/config/template/flavour/micronaut-4/DocController.ftl

Lines changed: 9 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,23 @@
11
<#import '../flavour-macro.ftl' as fhm>
22
package <@fhm.toProjectPackage context=context/>;
33

4-
import io.micronaut.http.annotation.*;
5-
64
import org.fugerit.java.core.cfg.ConfigRuntimeException;
7-
8-
import lombok.extern.slf4j.Slf4j;
95
import org.fugerit.java.doc.base.config.DocConfig;
106
import org.fugerit.java.doc.base.process.DocProcessContext;
117

128
import java.io.ByteArrayOutputStream;
139
import java.util.Arrays;
1410
import java.util.List;
1511

12+
import io.micronaut.http.annotation.*;
13+
14+
import io.swagger.v3.oas.annotations.Operation;
15+
import io.swagger.v3.oas.annotations.responses.ApiResponses;
16+
import io.swagger.v3.oas.annotations.responses.ApiResponse;
17+
import io.swagger.v3.oas.annotations.media.Content;
18+
19+
import lombok.extern.slf4j.Slf4j;
20+
1621
@Slf4j
1722
@Controller("/doc")
1823
public class DocController {

0 commit comments

Comments
 (0)