fix issue with import aliases (#483) (#573)

parser.go

@@ -46,6 +46,9 @@ type Parser struct {
 	// TypeDefinitions is a map that stores [package name][type name][*ast.TypeSpec]
 	TypeDefinitions map[string]map[string]*ast.TypeSpec
 
+	// ImportAliases is map that stores [import name][import package name][*ast.ImportSpec]
+	ImportAliases map[string]map[string]*ast.ImportSpec
+
 	// CustomPrimitiveTypes is a map that stores custom primitive types to actual golang types [type name][string]
 	CustomPrimitiveTypes map[string]string
 
@@ -85,6 +88,7 @@ func New(options ...func(*Parser)) *Parser {
 		},
 		files:                make(map[string]*ast.File),
 		TypeDefinitions:      make(map[string]map[string]*ast.TypeSpec),
+		ImportAliases:        make(map[string]map[string]*ast.ImportSpec),
 		CustomPrimitiveTypes: make(map[string]string),
 		registerTypes:        make(map[string]*ast.TypeSpec),
 	}
@@ -521,6 +525,23 @@ func (parser *Parser) ParseType(astFile *ast.File) {
 			}
 		}
 	}
+
+	for _, importSpec := range astFile.Imports {
+		if importSpec.Name == nil {
+			continue
+		}
+
+		alias := importSpec.Name.Name
+
+		if _, ok := parser.ImportAliases[alias]; !ok {
+			parser.ImportAliases[alias] = make(map[string]*ast.ImportSpec)
+		}
+
+		importParts := strings.Split(strings.Trim(importSpec.Path.Value, "\""), "/")
+		importPkgName := importParts[len(importParts)-1]
+
+		parser.ImportAliases[alias][importPkgName] = importSpec
+	}
 }
 
 func (parser *Parser) isInStructStack(refTypeName string) bool {

parser_test.go

@@ -2240,6 +2240,20 @@ func TestParseComposition(t *testing.T) {
 	assert.Equal(t, string(expected), string(b))
 }
 
+func TestParseImportAliases(t *testing.T) {
+	searchDir := "testdata/alias_import"
+	mainAPIFile := "main.go"
+	p := New()
+	err := p.ParseAPI(searchDir, mainAPIFile)
+	assert.NoError(t, err)
+
+	expected, err := ioutil.ReadFile(path.Join(searchDir, "expected.json"))
+	assert.NoError(t, err)
+
+	b, _ := json.MarshalIndent(p.swagger, "", "    ")
+	assert.Equal(t, string(expected), string(b))
+}
+
 // Disabled for resting purpose
 func disabledTestParseNested(t *testing.T) {
 	searchDir := "testdata/nested"

property.go

@@ -60,6 +60,19 @@ func parseFieldSelectorExpr(astTypeSelectorExpr *ast.SelectorExpr, parser *Parse
 			parser.ParseDefinition(pkgName.Name, astTypeSelectorExpr.Sel.Name, typeDefinitions)
 			return propertyNewFunc(astTypeSelectorExpr.Sel.Name, pkgName.Name)
 		}
+		if aliasedNames, ok := parser.ImportAliases[pkgName.Name]; ok {
+			for aliasedName := range aliasedNames {
+				if typeDefinitions, ok := parser.TypeDefinitions[aliasedName][astTypeSelectorExpr.Sel.Name]; ok {
+					if expr, ok := typeDefinitions.Type.(*ast.SelectorExpr); ok {
+						if primitiveType, err := convertFromSpecificToPrimitive(expr.Sel.Name); err == nil {
+							return propertyNewFunc(primitiveType, "")
+						}
+					}
+					parser.ParseDefinition(aliasedName, astTypeSelectorExpr.Sel.Name, typeDefinitions)
+					return propertyNewFunc(astTypeSelectorExpr.Sel.Name, aliasedName)
+				}
+			}
+		}
 		if actualPrimitiveType, isCustomType := parser.CustomPrimitiveTypes[astTypeSelectorExpr.Sel.Name]; isCustomType {
 			return propertyName{SchemaType: actualPrimitiveType, ArrayType: actualPrimitiveType}
 		}

testdata/alias_import/api/api.go

@@ -0,0 +1,28 @@
+package api
+
+import (
+	"github.com/gin-gonic/gin"
+	"github.com/swaggo/swag/testdata/alias_import/data"
+	"github.com/swaggo/swag/testdata/alias_type/types"
+	"log"
+)
+
+// @Summary Get application
+// @Description test get application
+// @ID get-application
+// @Accept  json
+// @Produce  json
+// @Success 200 {object} data.ApplicationResponse	"ok"
+// @Router /testapi/application [get]
+func GetApplication(c *gin.Context) {
+	var foo = data.ApplicationResponse{
+		Application: types.Application{
+			Name: "name",
+		},
+		ApplicationArray: []types.Application{
+			{Name: "name"},
+		},
+	}
+	log.Println(foo)
+	//write your code
+}

testdata/alias_import/data/applicationresponse.go

@@ -0,0 +1,11 @@
+package data
+
+import (
+	typesapplication "github.com/swaggo/swag/testdata/alias_import/types"
+)
+
+type ApplicationResponse struct {
+	Application      typesapplication.Application   `json:"application"`
+	ApplicationArray []typesapplication.Application `json:"application_array"`
+	ApplicationTime  typesapplication.DateOnly      `json:"application_time"`
+}

testdata/alias_import/expected.json

@@ -0,0 +1,71 @@
+{
+    "swagger": "2.0",
+    "info": {
+        "description": "This is a sample server Petstore server.",
+        "title": "Swagger Example API",
+        "termsOfService": "http://swagger.io/terms/",
+        "contact": {
+            "name": "API Support",
+            "url": "http://www.swagger.io/support",
+            "email": "support@swagger.io"
+        },
+        "license": {
+            "name": "Apache 2.0",
+            "url": "http://www.apache.org/licenses/LICENSE-2.0.html"
+        },
+        "version": "1.0"
+    },
+    "host": "petstore.swagger.io",
+    "basePath": "/v2",
+    "paths": {
+        "/testapi/application": {
+            "get": {
+                "description": "test get application",
+                "consumes": [
+                    "application/json"
+                ],
+                "produces": [
+                    "application/json"
+                ],
+                "summary": "Get application",
+                "operationId": "get-application",
+                "responses": {
+                    "200": {
+                        "description": "ok",
+                        "schema": {
+                            "$ref": "#/definitions/data.ApplicationResponse"
+                        }
+                    }
+                }
+            }
+        }
+    },
+    "definitions": {
+        "data.ApplicationResponse": {
+            "type": "object",
+            "properties": {
+                "application": {
+                    "type": "object",
+                    "$ref": "#/definitions/types.Application"
+                },
+                "application_array": {
+                    "type": "array",
+                    "items": {
+                        "$ref": "#/definitions/types.Application"
+                    }
+                },
+                "application_time": {
+                    "type": "string"
+                }
+            }
+        },
+        "types.Application": {
+            "type": "object",
+            "properties": {
+                "name": {
+                    "type": "string"
+                }
+            }
+        }
+    }
+}

testdata/alias_import/main.go

@@ -0,0 +1,26 @@
+package alias_import
+
+import (
+	"github.com/gin-gonic/gin"
+	"github.com/swaggo/swag/testdata/alias_import/api"
+)
+
+// @title Swagger Example API
+// @version 1.0
+// @description This is a sample server Petstore server.
+// @termsOfService http://swagger.io/terms/
+
+// @contact.name API Support
+// @contact.url http://www.swagger.io/support
+// @contact.email support@swagger.io
+
+// @license.name Apache 2.0
+// @license.url http://www.apache.org/licenses/LICENSE-2.0.html
+
+// @host petstore.swagger.io
+// @BasePath /v2
+func main() {
+	r := gin.New()
+	r.GET("/testapi/application", api.GetApplication)
+	r.Run()
+}

testdata/alias_import/types/application.go

@@ -0,0 +1,9 @@
+package types
+
+import "time"
+
+type Application struct {
+	Name string
+}
+
+type DateOnly time.Time