OpenAPI 3.1.0 Add webhooks support

modules/openapi-generator/src/main/java/org/openapitools/codegen/CodegenConfig.java

@@ -30,6 +30,7 @@
 import org.openapitools.codegen.model.ModelMap;
 import org.openapitools.codegen.model.ModelsMap;
 import org.openapitools.codegen.model.OperationsMap;
+import org.openapitools.codegen.model.WebhooksMap;
 
 import java.io.File;
 import java.util.List;
@@ -217,6 +218,8 @@ public interface CodegenConfig {
 
     OperationsMap postProcessOperationsWithModels(OperationsMap objs, List<ModelMap> allModels);
 
+    WebhooksMap postProcessWebhooksWithModels(WebhooksMap objs, List<ModelMap> allModels);
+
     Map<String, Object> postProcessSupportingFileData(Map<String, Object> objs);
 
     void postProcessModelProperty(CodegenModel model, CodegenProperty property);

modules/openapi-generator/src/main/java/org/openapitools/codegen/CodegenConstants.java

@@ -28,6 +28,7 @@ public class CodegenConstants {
     public static final String SUPPORTING_FILES = "supportingFiles";
     public static final String MODEL_TESTS = "modelTests";
     public static final String MODEL_DOCS = "modelDocs";
+    public static final String WEBHOOKS = "webhooks";
     public static final String API_TESTS = "apiTests";
     public static final String API_DOCS = "apiDocs";
 
@@ -296,6 +297,7 @@ public static enum ENUM_PROPERTY_NAMING_TYPE {camelCase, PascalCase, snake_case,
 
     public static final String GENERATE_APIS = "generateApis";
     public static final String GENERATE_API_DOCS = "generateApiDocs";
+    public static final String GENERATE_WEBHOOKS = "generateWebhooks";
 
     public static final String GENERATE_API_TESTS = "generateApiTests";
     public static final String GENERATE_API_TESTS_DESC = "Specifies that api tests are to be generated.";

modules/openapi-generator/src/main/java/org/openapitools/codegen/DefaultCodegen.java

@@ -60,6 +60,7 @@
 import org.openapitools.codegen.model.ModelMap;
 import org.openapitools.codegen.model.ModelsMap;
 import org.openapitools.codegen.model.OperationsMap;
+import org.openapitools.codegen.model.WebhooksMap;
 import org.openapitools.codegen.serializer.SerializerUtils;
 import org.openapitools.codegen.templating.MustacheEngineAdapter;
 import org.openapitools.codegen.templating.mustache.*;
@@ -977,6 +978,13 @@ public OperationsMap postProcessOperationsWithModels(OperationsMap objs, List<Mo
         return objs;
     }
 
+    // override with any special post-processing
+    @Override
+    @SuppressWarnings("static-method")
+    public WebhooksMap postProcessWebhooksWithModels(WebhooksMap objs, List<ModelMap> allModels) {
+        return objs;
+    }
+
     // override with any special post-processing
     @Override
     @SuppressWarnings("static-method")

modules/openapi-generator/src/main/java/org/openapitools/codegen/model/WebhooksMap.java

@@ -0,0 +1,24 @@
+package org.openapitools.codegen.model;
+
+import java.util.HashMap;
+import java.util.List;
+import java.util.Map;
+
+public class WebhooksMap extends HashMap<String, Object> {
+    public OperationMap getWebhooks() {
+        return (OperationMap) get("operations");
+    }
+
+    public void setWebhooks(OperationMap objs) {
+        put("operations", objs);
+    }
+
+    @SuppressWarnings("unchecked")
+    public List<Map<String, String>> getImports() {
+        return (List<Map<String, String>>) get("imports");
+    }
+
+    public void setImports(List<Map<String, String>> imports) {
+        put("imports", imports);
+    }
+}

modules/openapi-generator/src/main/resources/go-gin-server/routers.mustache

@@ -55,13 +55,19 @@ type ApiHandleFunctions struct {
 }
 
 func getRoutes(handleFunctions ApiHandleFunctions) []Route {
-	return []Route{
-	{{#apiInfo}}{{#apis}}{{#operations}}{{#operation}}
+	return []Route{ {{#apiInfo}}{{#apis}}{{#operations}}{{#operation}}
 		{
 			"{{operationId}}",
 			http.Method{{httpMethod}},
 			"{{{basePathWithoutHost}}}{{{path}}}",
 			handleFunctions.{{classname}}.{{operationId}},
-		},{{/operation}}{{/operations}}{{/apis}}{{/apiInfo}}
+		},{{/operation}}{{/operations}}{{/apis}}{{/apiInfo}}{{#webhooks}}{{#operations}}{{#operation}}
+		// webhook handler (adjust path accordingly)
+		{
+			"{{operationId}}",
+			http.Method{{httpMethod}},
+			"{{{basePathWithoutHost}}}{{{path}}}",
+			handleFunctions.{{classname}}.{{operationId}},
+		},{{/operation}}{{/operations}}{{/webhooks}}
 	}
 }

modules/openapi-generator/src/test/java/org/openapitools/codegen/DefaultCodegenTest.java

@@ -51,6 +51,7 @@
 import org.testng.annotations.Test;
 
 import java.io.File;
+import java.io.IOException;
 import java.nio.file.Files;
 import java.util.*;
 import java.util.stream.Collectors;
@@ -4808,4 +4809,18 @@ void testIsXML() {
         Assert.assertTrue(codegen.isXmlMimeType("application/xml"));
         Assert.assertTrue(codegen.isXmlMimeType("application/rss+xml"));
     }
+
+    @Test
+    public void testWebhooks() throws IOException {
+        final OpenAPI openAPI = TestUtils.parseFlattenSpec("src/test/resources/3_1/webhooks.yaml");
+        final DefaultCodegen codegen = new DefaultCodegen();
+        codegen.setOpenAPI(openAPI);
+
+        Operation operation = openAPI.getWebhooks().get("newPet").getPost();
+        CodegenOperation co = codegen.fromOperation("newPet", "get", operation, null);
+
+        Assert.assertEquals(co.path, "/newPet");
+        Assert.assertEquals(co.operationId, "newPetGet");
+    }
+
 }

modules/openapi-generator/src/test/java/org/openapitools/codegen/goginserver/GoGinServerCodegenTest.java

@@ -59,4 +59,25 @@ public void verifyGoMod() throws IOException {
                 "require github.com/gin-gonic/gin v1.9.1");
     }
 
+    @Test
+    public void webhooks() throws IOException {
+        File output = Files.createTempDirectory("test").toFile();
+        output.deleteOnExit();
+
+        final CodegenConfigurator configurator = new CodegenConfigurator()
+                .setGeneratorName("go-gin-server")
+                .setGitUserId("my-user")
+                .setGitRepoId("my-repo")
+                .setPackageName("my-package")
+                .setInputSpec("src/test/resources/3_1/webhooks.yaml")
+                .setOutputDir(output.getAbsolutePath().replace("\\", "/"));
+
+        DefaultGenerator generator = new DefaultGenerator();
+        List<File> files = generator.opts(configurator.toClientOptInput()).generate();
+        files.forEach(File::deleteOnExit);
+
+        TestUtils.assertFileContains(Paths.get(output + "/go/routers.go"),
+                "NewPetPost");
+    }
+
 }

modules/openapi-generator/src/test/resources/3_1/webhooks.yaml

@@ -0,0 +1,34 @@
+openapi: 3.1.0
+info:
+  title: Webhook Example
+  version: 1.0.0
+# Since OAS 3.1.0 the paths element isn't necessary. Now a valid OpenAPI Document can describe only paths, webhooks, or even only reusable components
+webhooks:
+  # Each webhook needs a name
+  newPet:
+    # This is a Path Item Object, the only difference is that the request is initiated by the API provider
+    post:
+      requestBody:
+        description: Information about a new pet in the system
+        content:
+          application/json:
+            schema:
+              $ref: "#/components/schemas/Pet"
+      responses:
+        "200":
+          description: Return a 200 status to indicate that the data was received successfully
+
+components:
+  schemas:
+    Pet:
+      required:
+        - id
+        - name
+      properties:
+        id:
+          type: integer
+          format: int64
+        name:
+          type: string
+        tag:
+          type: string

samples/server/petstore/go-gin-api-server/go/routers.go

@@ -67,8 +67,7 @@ type ApiHandleFunctions struct {
 }
 
 func getRoutes(handleFunctions ApiHandleFunctions) []Route {
-	return []Route{
-
+	return []Route{ 
 		{
 			"AddPet",
 			http.MethodPost,