如何正确地使用对象路径在Golang Swagger?

yqkkidmi  于 2023-02-22  发布在  Go
关注(0)|答案(1)|浏览(151)

我在Golang中使用swag,我想知道如何在一个类似的路径中准确地选择和使用多个dataClass,下面的示例中详细描述了这一点。
我的代码中有3个dataClass

1. ../dataClass/v1/auth/res/createUser.go  <<<< i want use this in swag doc
   2. ../dataClass/v2/auth/res/createUser.go
   3. ../dataClass/v1/file/res/createUser.go

下面是一个API,在这个api例子中,我想使用上面@success 200 {object} res.UserCreateRes行中的dataClass编号1,但是路径是重复的。

// @Summary 게스트 유저를 생성합니다
// @Description 게스트 유저를 생성합니다.
// @Tags 회원
// @Accept json
// @Produce json
// @Success 200 {object} res.UserCreateRes <<<<<<<<<<<<<<<<<<<<<
// @Failure 400 {object} common.DetaultError
// @Router /v1/auth/guestRegister [post]

我想精确地表示我想要的dataClass,但是我不知道怎么做。接下来我该怎么做?

sy5wg1nm

sy5wg1nm1#

我在网上搜索了一下,找到了一些解决方案,如果我没理解错的话,这里有三种方法可以让你在Swag中准确地选择和使用多个类似路径的dataClass:
首先,指定要用于声明成功状态代码的确切路径和dataClass(例如,@success 200 {object} res.AuthCreateUser.UserCreateRes)。
其次,为每个dataClass创建多个路径,使其与其他路径不同(例如/v1/auth/guestRegister和/v1/file/guestRegister)。
第三,使用go-swagger包定义自定义标记来表示您想要使用的不同dataClass(例如@res.AuthCreateUser或@res.FileCreateUser)。
让我知道如果有帮助,希望能帮助你。

相关问题