acacode / acacode/swagger-typescript-api

Support for dates

Open
#105 11 comments 11 reactions 1 assignee Claimed by @js2me View on GitHub
enhancement
Dominant language
TypeScript
Stars
4.1k
Forks
436
PR merge metrics
No merged PRs in 30d

Description

## 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.

Contributor guide

No contributing guide indexed for this repository

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.