Introduce content type into generated JSON types (oapi-codegen#1078)

jamietanna · danicc097 · commit b148b959c20c · 2024-08-31T15:59:31.000+02:00
* Introduce content type into generated JSON types As noted in oapi-codegen#1051, we have cases where multiple uses of JSON types leads to a clash in generated type names. This is a slight breaking change for folks' generated code, but ensures that conflicts do not happen, and that we are more predictable with generated type names. Closes oapi-codegen#1051. * Add gorilla/mux to the README
diff --git a/README.md b/README.md
@@ -15,10 +15,10 @@ you can focus on implementing the business logic for your service.
 
 We have chosen to focus on [Echo](https://github.com/labstack/echo) as
 our default HTTP routing engine, due to its speed and simplicity for the generated
-stubs, and [Chi](https://github.com/go-chi/chi), and [Gin](https://github.com/gin-gonic/gin)
-have also been added by contributors as additional routers. We chose Echo because
-the `Context` object is a mockable interface, and it allows for some advanced
-testing.
+stubs, and [Chi](https://github.com/go-chi/chi), [Gin](https://github.com/gin-gonic/gin),
+and [gorilla/mux](https://github.com/gorilla/mux) have also been added by
+contributors as additional routers. We chose Echo because the `Context` object
+is a mockable interface, and it allows for some advanced testing.
 
 This package tries to be too simple rather than too generic, so we've made some
 design decisions in favor of simplicity, knowing that we can't generate strongly
diff --git a/internal/test/schemas/schemas.gen.go b/internal/test/schemas/schemas.gen.go
diff --git a/internal/test/schemas/schemas.yaml b/internal/test/schemas/schemas.yaml
@@ -133,7 +133,20 @@ paths:
             application/json:
               schema:
                 $ref: "#/components/schemas/DeprecatedProperty"
-
+  /issues/1051:
+    get:
+      operationId: Issue1051
+      description: |
+        Multiple media types contain JSON
+      responses:
+        '200':
+          content:
+            application/vnd.something.v1+json:
+              schema:
+                type: object
+            application/json:
+              schema:
+                type: object
 components:
   schemas:
     GenericObject:
diff --git a/pkg/codegen/operations.go b/pkg/codegen/operations.go
@@ -293,12 +293,18 @@ func (o *OperationDefinition) GetResponseTypeDefinitions() ([]ResponseTypeDefini
 
 					var typeName string
 					switch {
+
 					// HAL+JSON:
 					case StringInArray(contentTypeName, contentTypesHalJSON):
 						typeName = fmt.Sprintf("HALJSON%s", ToCamelCase(responseName))
-					// JSON:
-					case StringInArray(contentTypeName, contentTypesJSON) || util.IsMediaTypeJson(contentTypeName):
+					case "application/json" == contentTypeName:
+						// if it's the standard application/json
 						typeName = fmt.Sprintf("JSON%s", ToCamelCase(responseName))
+					// Vendored JSON
+					case StringInArray(contentTypeName, contentTypesJSON) || util.IsMediaTypeJson(contentTypeName):
+						baseTypeName := fmt.Sprintf("%s%s", ToCamelCase(contentTypeName), ToCamelCase(responseName))
+
+						typeName = strings.ReplaceAll(baseTypeName, "Json", "JSON")
 					// YAML:
 					case StringInArray(contentTypeName, contentTypesYAML):
 						typeName = fmt.Sprintf("YAML%s", ToCamelCase(responseName))
