How to use a type definition in another file with swaggo?

Question

I am using swaggo generate API document based on godoc syntax.

Source folder and files

|-post
|--controller.go
|--response.go

For this definition:

controller.go

package post

...

// Index godoc
// @Summary Index Post
// @Success 200 {array} []*Response
// @Router /v1/posts [get]
func Index(ctx *gin.Context) {
  ...
}

The Response is been defined in an another file but the same package.

response.go

package post

// Response  is post response body
type Response struct {
    ID   int64  `json:"id"`
    Name string `json:"name"`

    CreatedAt string `json:"created_at"`
    UpdatedAt string `json:"updated_at"`
}

But when run swag init to generate swagger docs, it said:

2021/01/29 09:39:56 Generate swagger docs....
2021/01/29 09:39:56 Generate general API Info, search dir:./
2021/01/29 09:39:56 ParseComment error in file application/post/controller.go :cannot find type definition:

When I move the Response struct to controller.go, it works.

How to import it with godoc or swaggo?

Conclusion

Answer 1

I also encountered this problem, but I solved it with the below command:

swag init --parseDependency --parseInternal

Eusebiaeusebio

I tried this for echo, and is working fine – Milwaukee

Answer 2

You need to append --parseDependency to the swag init command.

Fealty

Answer 3

For a quick solution, run

go get -u github.com/swaggo/swag/cmd/[email protected]

You can find more about this solution here.

Cheston

Answer 4

swag init --parseDependency true should solve your issue

Doridoria

Answer 5

with swag v1.8.12, you can use full path for a type, replacing any . or / with _.

For example, for type MyStruct defined in github.com/john/project/controller, you can use github_com_john_project_controller.MyStruct

It doesn't work for older swag versions, at least not for v1.8.0

Medicine