Add configuration for tags, operationId etc.

pe-st · Nov 26, 2023 · 44fbcb4 · 44fbcb4
1 parent b8aee96
commit 44fbcb4
Show file tree

Hide file tree

Showing 10 changed files with 31 additions and 12 deletions.
diff --git a/code-first-openapi-quarkus/src/main/resources/META-INF/microprofile-config.properties b/code-first-openapi-quarkus/src/main/resources/META-INF/microprofile-config.properties
@@ -1,4 +1,5 @@
 # Smallrye-specific options
+mp.openapi.extensions.smallrye.operationIdStrategy=METHOD
 
 # keep /openapi instead /q/openapi for the time being
 # see https://quarkus.io/blog/path-resolution-in-quarkus/

diff --git a/code-first-openapi-quarkus/src/test/resources/openapi-sorted.yaml.txt b/code-first-openapi-quarkus/src/test/resources/openapi-sorted.yaml.txt
@@ -6,6 +6,7 @@ info:
 paths:
   /api/txproc/pincheck:
     post:
+      operationId: pinCheck
       requestBody:
         content:
           application/json:
@@ -25,6 +26,7 @@ paths:
       - Tx Proc
   /api/txproc/purchase:
     post:
+      operationId: purchase
       requestBody:
         content:
           application/json:

diff --git a/code-first-openapi-quarkus/src/test/resources/openapi.json.txt b/code-first-openapi-quarkus/src/test/resources/openapi.json.txt
@@ -9,6 +9,7 @@
       "post" : {
         "tags" : [ "Tx Proc" ],
         "summary" : "Check the pin",
+        "operationId" : "pinCheck",
         "requestBody" : {
           "description" : "PIN Check Request Body",
           "content" : {
@@ -38,6 +39,7 @@
       "post" : {
         "tags" : [ "Tx Proc" ],
         "summary" : "Authorize a Purchase",
+        "operationId" : "purchase",
         "requestBody" : {
           "description" : "Purchase Request Body",
           "content" : {

diff --git a/code-first-openapi-quarkus/src/test/resources/openapi.yaml.txt b/code-first-openapi-quarkus/src/test/resources/openapi.yaml.txt
@@ -9,6 +9,7 @@ paths:
       tags:
       - Tx Proc
       summary: Check the pin
+      operationId: pinCheck
       requestBody:
         description: PIN Check Request Body
         content:
@@ -28,6 +29,7 @@ paths:
       tags:
       - Tx Proc
       summary: Authorize a Purchase
+      operationId: purchase
       requestBody:
         description: Purchase Request Body
         content:

diff --git a/code-first-swagger/pom.xml b/code-first-swagger/pom.xml
@@ -120,6 +120,7 @@
                         <package>ch.schlau.pesche.apidocs.swagger.codefirst</package>
                     </resourcePackages>
                     <prettyPrint>true</prettyPrint>
+                    <alwaysResolveAppPath>true</alwaysResolveAppPath>
                 </configuration>
                 <executions>
                     <execution>

diff --git a/code-first-swagger/src/main/java/ch/schlau/pesche/apidocs/swagger/codefirst/rest/TxProc.java b/code-first-swagger/src/main/java/ch/schlau/pesche/apidocs/swagger/codefirst/rest/TxProc.java
@@ -27,7 +27,8 @@ public class TxProc {
 
     @Path("/pincheck")
     @POST
-    @Operation(summary = "Check the pin")
+    @Operation(summary = "Check the pin",
+               tags = {"Tx Proc"})
     @ApiResponse(description = "PIN Check Response",
                  content = @Content(schema = @Schema(implementation = PinCheckResponse.class)))
     public PinCheckResponse pinCheck(
@@ -48,7 +49,8 @@ public PinCheckResponse pinCheck(
 
     @Path("/purchase")
     @POST
-    @Operation(summary = "Authorize a Purchase")
+    @Operation(summary = "Authorize a Purchase",
+               tags = {"Tx Proc"})
     @ApiResponse(description = "Purchase Response",
                  content = @Content(schema = @Schema(implementation = PurchaseAuthResponse.class)))
     public PurchaseAuthResponse purchase(

diff --git a/...t-swagger/src/test/java/ch/schlau/pesche/apidocs/swagger/codefirst/OpenapiDocumentIT.java b/...t-swagger/src/test/java/ch/schlau/pesche/apidocs/swagger/codefirst/OpenapiDocumentIT.java
@@ -55,8 +55,7 @@ void openapi_yaml() throws IOException {
         String yamlSorted = sortYaml(document);
 
         assertAll("openapi yaml"
-                // the unsorted document generated by Swagger has no deterministic order
-                // , () -> assertThat("unsorted", document, is(expected))
+                , () -> assertThat("unsorted", document, is(expected))
                 , () -> assertThat("sorted", yamlSorted, is(expectedSorted))
         );
     }

diff --git a/code-first-swagger/src/test/resources/openapi-sorted.yaml.txt b/code-first-swagger/src/test/resources/openapi-sorted.yaml.txt
@@ -4,7 +4,7 @@ info:
   title: txproc-code-first-swagger
   version: 0.9
 paths:
-  /txproc/pincheck:
+  /api/txproc/pincheck:
     post:
       operationId: pinCheck
       requestBody:
@@ -22,7 +22,9 @@ paths:
                 $ref: '#/components/schemas/PinCheckResponse'
           description: PIN Check Response
       summary: Check the pin
-  /txproc/purchase:
+      tags:
+      - Tx Proc
+  /api/txproc/purchase:
     post:
       operationId: purchase
       requestBody:
@@ -40,6 +42,8 @@ paths:
                 $ref: '#/components/schemas/PurchaseAuthResponse'
           description: Purchase Response
       summary: Authorize a Purchase
+      tags:
+      - Tx Proc
 components:
   schemas:
     EmvTags:

diff --git a/code-first-swagger/src/test/resources/openapi.json.txt b/code-first-swagger/src/test/resources/openapi.json.txt
@@ -5,8 +5,9 @@
     "version" : "0.9"
   },
   "paths" : {
-    "/txproc/pincheck" : {
+    "/api/txproc/pincheck" : {
       "post" : {
+        "tags" : [ "Tx Proc" ],
         "summary" : "Check the pin",
         "operationId" : "pinCheck",
         "requestBody" : {
@@ -34,8 +35,9 @@
         }
       }
     },
-    "/txproc/purchase" : {
+    "/api/txproc/purchase" : {
       "post" : {
+        "tags" : [ "Tx Proc" ],
         "summary" : "Authorize a Purchase",
         "operationId" : "purchase",
         "requestBody" : {

diff --git a/code-first-swagger/src/test/resources/openapi.yaml.txt b/code-first-swagger/src/test/resources/openapi.yaml.txt
@@ -4,8 +4,10 @@ info:
   title: txproc-code-first-swagger
   version: "0.9"
 paths:
-  /txproc/pincheck:
+  /api/txproc/pincheck:
     post:
+      tags:
+      - Tx Proc
       summary: Check the pin
       operationId: pinCheck
       requestBody:
@@ -22,8 +24,10 @@ paths:
             application/json:
               schema:
                 $ref: '#/components/schemas/PinCheckResponse'
-  /txproc/purchase:
+  /api/txproc/purchase:
     post:
+      tags:
+      - Tx Proc
       summary: Authorize a Purchase
       operationId: purchase
       requestBody:
@@ -65,8 +69,8 @@ components:
       type: object
       properties:
         uuid:
-          description: Unique ID of the request
           format: uuid
+          description: Unique ID of the request
           type: string
         pan:
           title: PAN (Primary Account Number)
@@ -111,8 +115,8 @@ components:
       type: object
       properties:
         uuid:
-          description: Unique ID of the request
           format: uuid
+          description: Unique ID of the request
           type: string
         pan:
           title: PAN (Primary Account Number)