在Go中使用自定义类型与Swagger集成

在Go语言中，自定义类型可以帮助我们更好地组织代码和增强可读性。在本篇博客中，我们将探讨如何创建一个自定义类型，并将其与Swagger文档集成，以便在API中正确序列化和展示。

1. 创建自定义类型

首先，我们定义一个名为 RechargeType 的自定义类型。这个类型将用于表示不同的充值方式。

 

package main

// RechargeType 自定义类型
type RechargeType string

const (
    RechargeTypeChain RechargeType = "chain" // 链上充值
    RechargeTypeScan  RechargeType = "scan"  // 扫码充值
    RechargeTypeXTR   RechargeType = "star"  // 星币充值
    RechargeTypeRUB   RechargeType = "rub"   // 卢布充值
)

 

2. 定义结构体

接下来，我们定义一个结构体 MyStruct，其中包含一个 RechargeType 类型的字段。我们将使用这个结构体作为API请求和响应的基础。

 

// MyStruct 示例结构体
type MyStruct struct {
    Type RechargeType `json:"type" swaggertype:"string"` // 使用 swaggertype 标签
}

2.1 JSON序列化与反序列化

为了确保我们的自定义类型能够正确地序列化为JSON格式，我们需要实现 MarshalJSON 和 UnmarshalJSON 方法：

import (
    "encoding/json"
)

// MarshalJSON 自定义序列化方法
func (r RechargeType) MarshalJSON() ([]byte, error) {
    return json.Marshal(string(r))
}

// UnmarshalJSON 自定义反序列化方法
func (r *RechargeType) UnmarshalJSON(data []byte) error {
    var s string
    if err := json.Unmarshal(data, &s); err != nil {
        return err
    }
    *r = RechargeType(s)
    return nil
}

 

 

3. 集成Swagger

要使Swagger能够识别我们的自定义类型并生成文档，我们需要确保在结构体字段上添加适当的注释。然后，运行以下命令以生成Swagger文档：

bash

swag init

此命令会扫描您的代码并生成所需的Swagger配置。

5. 总结

通过以上步骤，我们成功创建了一个自定义类型，并将其与Swagger集成。这使得我们的API不仅能够正确处理请求和响应，还能在Swagger文档中清晰地展示该字段的含义和有效值。这样的做法提升了代码的可读性和可维护性，也为其他开发者提供了更好的使用体验。