acacode / acacode/swagger-typescript-api

Support for dates

未关闭
#105 11 条评论 11 个 reaction 已指派 1 人 已被 @js2me 认领 在 GitHub 查看
enhancement
主要语言
TypeScript
星标
4.1k
派生
436
PR 合并指标
30 天内没有已合并 PR

描述

## Problem

Currently this library seems to ignore `format` information on data types. Most formats just add some metadata, so they are fine to skip, but `format: date-time` actually has semantic meaning that _could_ be understood by a typescript client.

Right now, if we have a model definition like this:

```json
"SomeType": {
"properties": {
"created": {
"type": "string",
"format": "date-time"
}
}
}
```

it generates this kind of model:

```ts
interface SomeType {
created: string;
}
```

There is no way for the client to know that this string represents a date. It would be really useful if it could generate this model instead:

```ts
interface SomeType {
created: Date;
}
```

## Implementation

I realize that adding custom data transformations is tricky and probably outside the scope of this library. But making only dates work might actually be possible.

Serializing data would be relatively straightforward. [JSON serialization](https://github.com/acacode/swagger-typescript-api/blob/master/src/templates/defaults/http-client.mustache#L75) would just work. For [form serialization](https://github.com/acacode/swagger-typescript-api/blob/master/src/templates/defaults/http-client.mustache#L77-L81) there would need to be a special case for `Date` instances.

The main challenge for implementation seems to make [safeParseResponse](https://github.com/acacode/swagger-typescript-api/blob/master/src/templates/defaults/http-client.mustache#L77-L81) work, because type information is not available at run-time. I think the only way to make that work is generate a custom parser per API type. Is that outside the scope of this library too?

## Further steps

I'd be happy to lend a hand if you think this would be a useful addition to the library. I am aware that templates can be customized, so I might also be able to work around this if necessary.

贡献指南

这个仓库没有索引到贡献指南

评估

这个 Issue 还没有评估数据。

把新 issue 发到你的邮箱

精选适合新手参与的 GitHub issue 摘要。