support x-go-type and x-go-type-import with ref

paulmach · paulmach · commit 345dc3f2642a · 2025-01-08T17:12:09.000-08:00
diff --git a/internal/test/extensions/x-go-type/config.yaml b/internal/test/extensions/x-go-type/config.yaml
@@ -0,0 +1,7 @@
+# yaml-language-server: $schema=../../../../configuration-schema.json
+package: xgotype
+generate:
+  models: true
+output: issue.gen.go
+output-options:
+  skip-prune: true
diff --git a/internal/test/extensions/x-go-type/generate.go b/internal/test/extensions/x-go-type/generate.go
@@ -0,0 +1,3 @@
+package xgotype
+
+//go:generate go run github.com/oapi-codegen/oapi-codegen/v2/cmd/oapi-codegen --config=config.yaml spec.yaml
diff --git a/internal/test/extensions/x-go-type/issue.gen.go b/internal/test/extensions/x-go-type/issue.gen.go
diff --git a/internal/test/extensions/x-go-type/spec.yaml b/internal/test/extensions/x-go-type/spec.yaml
@@ -0,0 +1,25 @@
+components:
+  schemas:
+    SomeInteger:
+      type: integer
+      x-go-type-import:
+        name: rate
+        path: golang.org/x/time/rate
+    SomeObject:
+      type: object
+      required:
+        - int_as_string
+        - int_as_big_int
+      properties:
+        int_as_string:
+          $ref: '#/components/schemas/SomeInteger'
+          x-go-type: string
+        int_as_rate_limit:
+          $ref: '#/components/schemas/SomeInteger'
+          x-go-type: rate.Limit
+        int_as_uuid:
+          $ref: '#/components/schemas/SomeInteger'
+          x-go-type: googleuuid.UUID
+          x-go-type-import:
+            path: github.com/google/uuid
+            name: googleuuid
diff --git a/pkg/codegen/codegen.go b/pkg/codegen/codegen.go
@@ -1092,15 +1092,18 @@ func GetTypeDefinitionsImports(swagger *openapi3.T, excludeSchemas []string) (ma
 func GoSchemaImports(schemas ...*openapi3.SchemaRef) (map[string]goImport, error) {
 	res := map[string]goImport{}
 	for _, sref := range schemas {
-		if sref == nil || sref.Value == nil || IsGoTypeReference(sref.Ref) {
+		if sref == nil {
 			return nil, nil
 		}
+
 		if gi, err := ParseGoImportExtension(sref); err != nil {
 			return nil, err
-		} else {
-			if gi != nil {
-				res[gi.String()] = *gi
-			}
+		} else if gi != nil {
+			res[gi.String()] = *gi
+		}
+
+		if sref.Value == nil || IsGoTypeReference(sref.Ref) {
+			continue
 		}
 		schemaVal := sref.Value
 
diff --git a/pkg/codegen/schema.go b/pkg/codegen/schema.go
@@ -257,11 +257,24 @@ func GenerateGoSchema(sref *openapi3.SchemaRef, path []string) (Schema, error) {
 	// If Ref is set on the SchemaRef, it means that this type is actually a reference to
 	// another type. We're not de-referencing, so simply use the referenced type.
 	if IsGoTypeReference(sref.Ref) {
-		// Convert the reference path to Go type
-		refType, err := RefPathToGoType(sref.Ref)
-		if err != nil {
-			return Schema{}, fmt.Errorf("error turning reference (%s) into a Go type: %s",
-				sref.Ref, err)
+		var refType string
+
+		// check if there is an x-go-type extension next to the $ref and use that over the overrided type.
+		if extension, ok := sref.Extensions[extPropGoType]; ok {
+			var ok bool
+			refType, ok = extension.(string)
+			if !ok {
+				return Schema{}, fmt.Errorf("error turning '%s: %v' into string",
+					extPropGoType, extension)
+			}
+		} else {
+			// Convert the reference path to Go type
+			var err error
+			refType, err = RefPathToGoType(sref.Ref)
+			if err != nil {
+				return Schema{}, fmt.Errorf("error turning reference (%s) into a Go type: %s",
+					sref.Ref, err)
+			}
 		}
 		return Schema{
 			GoType:         refType,
diff --git a/pkg/codegen/utils.go b/pkg/codegen/utils.go
@@ -1039,12 +1039,18 @@ func findSchemaNameByRefPath(refPath string, spec *openapi3.T) (string, error) {
 }
 
 func ParseGoImportExtension(v *openapi3.SchemaRef) (*goImport, error) {
-	if v.Value.Extensions[extPropGoImport] == nil || v.Value.Extensions[extPropGoType] == nil {
+	var goTypeImportExt any
+
+	// check extensions next to the $ref before checking the schema itself
+	// values next to $ref will be used before those in the actual schema
+	if v.Extensions[extPropGoImport] != nil {
+		goTypeImportExt = v.Extensions[extPropGoImport]
+	} else if v.Value.Extensions[extPropGoImport] != nil {
+		goTypeImportExt = v.Value.Extensions[extPropGoImport]
+	} else {
 		return nil, nil
 	}
 
-	goTypeImportExt := v.Value.Extensions[extPropGoImport]
-
 	importI, ok := goTypeImportExt.(map[string]interface{})
 	if !ok {
 		return nil, fmt.Errorf("failed to convert type: %T", goTypeImportExt)

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+package xgotype`
	`2`	`+`
	`3`	`+//go:generate go run github.com/oapi-codegen/oapi-codegen/v2/cmd/oapi-codegen --config=config.yaml spec.yaml`