TypeScript generated bindings not mapping to JSON property names

[corruptmem]

I'm using Swagger codegen to generate Angular Typescript bindings for a JSON web service. An example of one of my models from the Swagger definition is as follows:

NamePos:
  type: object
  properties:
    Name:
      type: string
    Position:
      type: string

And this is sent over the wire as the following JSON object:

{"Name": "x", "Position": "y"}

However, the TypeScript generator creates the following model:

export class CapitalStructure {
    name: string;
    position: string;
}

The API directly casts the returned JSON object into this model. What therefore happens, is that the obj.name is undefined, because the correct property name is actually obj.Name, but that's invalid according to to the generated TypeScript bindings.

As a workaround, I set it to use custom templates and in model.mustache, I changed this line:

{{name}}: {{#isEnum}}{{classname}}.{{{datatypeWithEnum}}}{{/isEnum}}{{^isEnum}}{{{datatype}}}{{/isEnum}};

Into

{{baseName}}: {{#isEnum}}{{classname}}.{{{datatypeWithEnum}}}{{/isEnum}}{{^isEnum}}{{{datatype}}}{{/isEnum}};

This now generates models with property names that match the JSON (Name, Position), and the generated bindings work as expected.

However, this would break if any of the properties contained a TypeScript reserved word, and also means the generated TypeScript doesn't follow general language conventions. The correct solution would likely to use some attribute maps from the name -> baseName and then perhaps getters/setters, as other language templates do (e.g. Ruby, Python, PHP). An example from the Python generator can be seen here: https://github.com/swagger-api/swagger-codegen/blob/master/modules/swagger-codegen/src/main/resources/python/model.mustache#L46

[wing328]

@corruptmem thanks for reporting the issue. I totally agree with you that an attribute map should be used for TypeScript to handle reserved keyword or other edge cases for property name. May I know if you've cycle to implement the attribute map for TypeScript?

[wing328]

@corruptmem I did some test and found that I could put double quote on property name that is reserved word, containing "-", starting with number, etc

export class TestObject {
    "The \"meaning\" of life": string;
    "type": string;
    "123-testing": number;
}

npm test didn't report any issue (FYI. I tested with typescript node but typescript angular should also work with the above)

Can you please give it a try to see if the above solution (double quote) works for you? If yes, we can file a PR to permanently address that as this solution is much easier to implement compared with attribute mapping.

[wing328]

@corruptmem fixed by #1979.