OpenAPI Golang 客户端在处理日期上存在问题？

编程并不是一个机械性的工作，而是需要有思考，有创新的工作，语法是固定的，但解决问题的思路则是依靠人的思维，这就需要我们坚持学习和更新自己的知识。今天golang学习网就整理分享《OpenAPI Golang 客户端在处理日期上存在问题？》，文章讲解的知识点主要包括，如果你对Golang方面的知识点感兴趣，就不要错过golang学习网，在这可以对大家的知识积累有所帮助，助力开发能力的提升。

我正在开发一个提供交​​易列表的 api。我用 java/kotlin spring 编写它，但更喜欢使用 golang 作为 cli，所以我为其生成一个 golang 客户端。该 api 在 swagger ui 中运行良好。

kotlin api：

@getmapping
fun listtransactions() : responseentity<list<transaction>> {
    val transactions = arraylist<transaction>()
    transactionrepository.findall().mapto(transactions) { fromentity(it) }
    return responseentity.ok(transactions)
}

kotlin 对象：

data class transaction(
        val id: long,
        val transactiondate: date, // java sql date
        val posteddate: date?, // java sql date
        val amount: bigdecimal,
        val category: category,
        val merchant: merchant,
        val merchantdescription: string?
)

生成的架构：

{
    "openapi": "3.0.1",
    "info": {
        "title": "bfi swagger title",
        "description": "bfi description",
        "version": "0.1"
    },
    "servers": [{
        "url": "http://localhost:8080",
        "description": "generated server url"
    }],
    "paths": {
        "/transaction": {
            "get": {
                "tags": ["transaction-router"],
                "operationid": "listtransactions",
                "responses": {
                    "200": {
                        "description": "ok",
                        "content": {
                            "*/*": {
                                "schema": {
                                    "type": "array",
                                    "items": {
                                        "$ref": "#/components/schemas/transaction"
                                    }
                                }
                            }
                        }
                    }
                }
            },
            "post": {
                "tags": ["transaction-router"],
                "operationid": "createtransaction",
                "requestbody": {
                    "content": {
                        "application/json": {
                            "schema": {
                                "$ref": "#/components/schemas/createtransactionrequest"
                            }
                        }
                    },
                    "required": true
                },
                "responses": {
                    "200": {
                        "description": "ok",
                        "content": {
                            "*/*": {
                                "schema": {
                                    "$ref": "#/components/schemas/transaction"
                                }
                            }
                        }
                    }
                }
            }
        },
        "/hello": {
            "get": {
                "tags": ["category-router"],
                "summary": "hello there!",
                "operationid": "hello",
                "responses": {
                    "200": {
                        "description": "ok",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/category"
                                }
                            }
                        }
                    }
                }
            }
        }
    },
    "components": {
        "schemas": {
            "createtransactionrequest": {
                "type": "object",
                "properties": {
                    "transactiondate": {
                        "type": "string",
                        "format": "date-time"
                    },
                    "posteddate": {
                        "type": "string",
                        "format": "date-time"
                    },
                    "amount": {
                        "type": "number"
                    },
                    "categoryid": {
                        "type": "integer",
                        "format": "int64"
                    },
                    "merchantid": {
                        "type": "integer",
                        "format": "int64"
                    },
                    "merchantdescription": {
                        "type": "string"
                    }
                }
            },
            "category": {
                "type": "object",
                "properties": {
                    "id": {
                        "type": "integer",
                        "format": "int64"
                    },
                    "name": {
                        "type": "string"
                    },
                    "note": {
                        "type": "string"
                    }
                }
            },
            "merchant": {
                "type": "object",
                "properties": {
                    "id": {
                        "type": "integer",
                        "format": "int64"
                    },
                    "name": {
                        "type": "string"
                    },
                    "note": {
                        "type": "string"
                    }
                }
            },
            "transaction": {
                "type": "object",
                "properties": {
                    "id": {
                        "type": "integer",
                        "format": "int64"
                    },
                    "transactiondate": {
                        "type": "string",
                        "format": "date-time"
                    },
                    "posteddate": {
                        "type": "string",
                        "format": "date-time"
                    },
                    "amount": {
                        "type": "number"
                    },
                    "category": {
                        "$ref": "#/components/schemas/category"
                    },
                    "merchant": {
                        "$ref": "#/components/schemas/merchant"
                    },
                    "merchantdescription": {
                        "type": "string"
                    }
                }
            }
        }
    }
}

golang 客户端对象：

type transaction struct {
   id *int64 `json:"id,omitempty"`
   transactiondate *time.time `json:"transactiondate,omitempty"`
   posteddate *time.time `json:"posteddate,omitempty"`
   amount *float32 `json:"amount,omitempty"`
   category *category `json:"category,omitempty"`
   merchant *merchant `json:"merchant,omitempty"`
   merchantdescription *string `json:"merchantdescription,omitempty"`
}

所有这些看起来都足够正确。但是，当我使用 openapi 客户端时，反序列化似乎无法正常工作：

Error when calling `TransactionRouterApi.ListTransactions``: parsing time "\"2022-10-28\"" as "\"2006-01-02T15:04:05Z07:00\"": cannot parse "\"" as "T"
Full HTTP response: &{200  200 HTTP/1.1 1 1 map[Content-Type:[application/json] Date:[Sat, 29 Oct 2022 04:03:31 GMT]] {[{"id":1,"transactionDate":"2022-10-28","postedDate":"2022-10-28","amount":0.00,"category":{"id":1,"name":"test","note":"test"},"merchant":{"id":1,"name":"test","note":"test"},"merchantDescription":null},{"id":2,"transactionDate":"2022-10-28","postedDate":"2022-10-28","amount":0.00,"category":{"id":1,"name":"test","note":"test"},"merchant":{"id":1,"name":"test","note":"test"},"merchantDescription":null},{"id":3,"transactionDate":"2022-10-28","postedDate":"2022-10-28","amount":0.00,"category":{"id":1,"name":"test","note":"test"},"merchant":{"id":1,"name":"test","note":"test"},"merchantDescription":null}]} -1 [chunked] false false map[] 0x140001daf00 <nil>}
Response from `TransactionRouterApi.ListTransactions`: [{0x140000aa218 0001-01-01 00:00:00 +0000 UTC <nil> <nil> <nil> <nil> <nil>}]

我是否做错了什么导致反序列化失败？或者这是一个客户端错误（似乎很可疑，但谁知道呢）。

我查看了我使用的生成参数和端点上可用的架构，它们看起来都是正确的。

执行脚本：openapi-generator-cli生成-g go -i http://localhost:8080/v3/api-docs

正确答案

两个选项：

1. 创建自定义类型并为日期字段实现 Unmarshaler 接口。
2. 从 API 返回有效的 RFC 3339 日期/时间。

今天关于《OpenAPI Golang 客户端在处理日期上存在问题？》的内容就介绍到这里了，是不是学起来一目了然！想要了解更多关于的内容请关注golang学习网公众号！