Skip to content

Commit b8fc5d0

Browse files
KirylKovaliovKirylKovaliov
authored
Merge pull request #228 from regulaforensics/feature/42782
42782 - added two client generation modes
2 parents d6a3fa4 + 32f8b69 commit b8fc5d0

File tree

13 files changed

+1469
-23
lines changed

13 files changed

+1469
-23
lines changed

‎.openapi-generator/VERSION‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
7.13.0
1+
7.15.0

‎dev.md‎

Lines changed: 14 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -13,16 +13,23 @@ and use next command from the project root.
1313

1414
## Generator configuration Features
1515

16-
1. The generator does not generate long enums, the problem
17-
is solved by adding the edited template modelEnum.mustache.
18-
2. When generating oneOf schemas, the generator creates its
16+
1. Two client generation modes have been added:
17+
strict (for client testing) and lenient (for release).
18+
In strict mode, the client will throw an exception if the
19+
types do not match or the required fields are missing;
20+
in lenient mode, error data will be output as a warning to
21+
the console. The templates for generating these modes
22+
are located in the generator-templates folder.
23+
2. The generator does not generate long enums, the problem
24+
is solved by adding the edited template modelEnum.mustache (for both modes).
25+
3. When generating oneOf schemas, the generator creates its
1926
own abstract class, which does not look like it would like.
2027
The problem was solved by replacing the abstract generator
2128
class with ours using typeMappings in the generator config.
22-
3. The generator sets the discriminator name incorrectly, the problem
23-
is solved by adding and editing the modelGeneric.mustache template.
24-
4. Changes have also been made to modelsGeneric.mustache to exclude
25-
unspecified fields from JSON when serializing a class.
29+
4. The generator sets the discriminator name incorrectly, the problem
30+
is solved by adding and editing the modelGeneric.mustache template (for both modes).
31+
5. Changes have also been made to modelsGeneric.mustache to exclude
32+
unspecified fields from JSON when serializing a class (for both modes).
2633

2734
## Problem solving
2835

‎generator-templates/lenient/ApiClient.mustache‎

Lines changed: 801 additions & 0 deletions
Large diffs are not rendered by default.

generator-templates/modelEnum.mustache renamed to generator-templates/lenient/modelEnum.mustache

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -141,7 +141,7 @@
141141
/// <param name="options"></param>
142142
public override void Write(Utf8JsonWriter writer, {{datatypeWithEnum}}{{^datatypeWithEnum}}{{classname}}{{/datatypeWithEnum}} {{#lambda.camelcase_sanitize_param}}{{datatypeWithEnum}}{{^datatypeWithEnum}}{{classname}}{{/datatypeWithEnum}}{{/lambda.camelcase_sanitize_param}}, JsonSerializerOptions options)
143143
{
144-
writer.WriteStringValue({{#lambda.camelcase_sanitize_param}}{{datatypeWithEnum}}{{^datatypeWithEnum}}{{classname}}{{/datatypeWithEnum}}{{/lambda.camelcase_sanitize_param}}.ToString());
144+
writer.WriteStringValue({{datatypeWithEnum}}{{^datatypeWithEnum}}{{classname}}{{/datatypeWithEnum}}ValueConverter.ToJsonValue({{#lambda.camelcase_sanitize_param}}{{datatypeWithEnum}}{{^datatypeWithEnum}}{{classname}}{{/datatypeWithEnum}}{{/lambda.camelcase_sanitize_param}}).ToString());
145145
}
146146
}
147147

@@ -172,14 +172,14 @@
172172
}
173173

174174
/// <summary>
175-
/// Writes the DateTime to the json writer
175+
/// Writes the {{datatypeWithEnum}}{{^datatypeWithEnum}}{{classname}}{{/datatypeWithEnum}} to the json writer
176176
/// </summary>
177177
/// <param name="writer"></param>
178178
/// <param name="{{#lambda.camelcase_sanitize_param}}{{datatypeWithEnum}}{{^datatypeWithEnum}}{{classname}}{{/datatypeWithEnum}}{{/lambda.camelcase_sanitize_param}}"></param>
179179
/// <param name="options"></param>
180180
public override void Write(Utf8JsonWriter writer, {{datatypeWithEnum}}{{^datatypeWithEnum}}{{classname}}{{/datatypeWithEnum}}? {{#lambda.camelcase_sanitize_param}}{{datatypeWithEnum}}{{^datatypeWithEnum}}{{classname}}{{/datatypeWithEnum}}{{/lambda.camelcase_sanitize_param}}, JsonSerializerOptions options)
181181
{
182-
writer.WriteStringValue({{#lambda.camelcase_sanitize_param}}{{datatypeWithEnum}}{{^datatypeWithEnum}}{{classname}}{{/datatypeWithEnum}}{{/lambda.camelcase_sanitize_param}}?.ToString() ?? "null");
182+
writer.WriteStringValue({{#lambda.camelcase_sanitize_param}}{{datatypeWithEnum}}{{^datatypeWithEnum}}{{classname}}{{/datatypeWithEnum}}{{/lambda.camelcase_sanitize_param}}.HasValue ? {{datatypeWithEnum}}{{^datatypeWithEnum}}{{classname}}{{/datatypeWithEnum}}ValueConverter.ToJsonValue({{#lambda.camelcase_sanitize_param}}{{datatypeWithEnum}}{{^datatypeWithEnum}}{{classname}}{{/datatypeWithEnum}}{{/lambda.camelcase_sanitize_param}}.Value).ToString() : "null");
183183
}
184184
}
185185
{{/useGenericHost}}

generator-templates/modelGeneric.mustache renamed to generator-templates/lenient/modelGeneric.mustache

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -25,12 +25,14 @@
2525
{{#items}}
2626
{{^complexType}}
2727
{{>modelInnerEnum}}
28+
2829
{{/complexType}}
2930
{{/items}}
3031
{{/items.isEnum}}
3132
{{#isEnum}}
3233
{{^complexType}}
3334
{{>modelInnerEnum}}
35+
3436
{{/complexType}}
3537
{{/isEnum}}
3638
{{#isEnum}}
@@ -428,5 +430,6 @@
428430

429431
{{#validatable}}
430432
{{>validatable}}
433+
431434
{{/validatable}}
432435
}

‎generator-templates/strict/modelEnum.mustache‎

Lines changed: 185 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,185 @@
1+
/// <summary>
2+
/// {{description}}{{^description}}Defines {{{name}}}{{/description}}
3+
/// </summary>
4+
{{#description}}
5+
/// <value>{{.}}</value>
6+
{{/description}}
7+
{{#vendorExtensions.x-cls-compliant}}
8+
[CLSCompliant({{{.}}})]
9+
{{/vendorExtensions.x-cls-compliant}}
10+
{{#vendorExtensions.x-com-visible}}
11+
[ComVisible({{{.}}})]
12+
{{/vendorExtensions.x-com-visible}}
13+
{{#allowableValues}}
14+
{{#enumVars}}
15+
{{#-first}}
16+
{{#isString}}
17+
{{^useGenericHost}}
18+
[JsonConverter(typeof(StringEnumConverter))]
19+
{{/useGenericHost}}
20+
{{/isString}}
21+
{{/-first}}
22+
{{/enumVars}}
23+
{{/allowableValues}}
24+
{{>visibility}} enum {{datatypeWithEnum}}{{^datatypeWithEnum}}{{classname}}{{#isLong}}: long{{/isLong}}{{/datatypeWithEnum}}{{#vendorExtensions.x-enum-byte}}: byte{{/vendorExtensions.x-enum-byte}}
25+
{
26+
{{#allowableValues}}
27+
{{#enumVars}}
28+
/// <summary>
29+
/// Enum {{name}} for value: {{value}}
30+
/// </summary>
31+
{{#isString}}
32+
{{^useGenericHost}}
33+
{{! EnumMember not currently supported in System.Text.Json, use a converter instead }}
34+
[EnumMember(Value = "{{{value}}}")]
35+
{{/useGenericHost}}
36+
{{/isString}}
37+
{{name}}{{^isString}} = {{{value}}}{{/isString}}{{#isString}}{{^vendorExtensions.x-zero-based-enum}} = {{-index}}{{/vendorExtensions.x-zero-based-enum}}{{/isString}}{{^-last}},{{/-last}}
38+
{{^-last}}
39+
40+
{{/-last}}
41+
{{/enumVars}}
42+
{{/allowableValues}}
43+
}
44+
{{#useGenericHost}}
45+
46+
/// <summary>
47+
/// Converts <see cref="{{datatypeWithEnum}}{{^datatypeWithEnum}}{{classname}}{{/datatypeWithEnum}}"/> to and from the JSON value
48+
/// </summary>
49+
public static class {{datatypeWithEnum}}{{^datatypeWithEnum}}{{classname}}{{/datatypeWithEnum}}ValueConverter
50+
{
51+
/// <summary>
52+
/// Parses a given value to <see cref="{{datatypeWithEnum}}{{^datatypeWithEnum}}{{classname}}{{/datatypeWithEnum}}"/>
53+
/// </summary>
54+
/// <param name="value"></param>
55+
/// <returns></returns>
56+
public static {{datatypeWithEnum}}{{^datatypeWithEnum}}{{classname}}{{/datatypeWithEnum}} FromString(string value)
57+
{
58+
{{#allowableValues}}
59+
{{#enumVars}}
60+
if (value.Equals({{^isString}}({{{value}}}).ToString(){{/isString}}{{#isString}}"{{{value}}}"{{/isString}}))
61+
return {{datatypeWithEnum}}{{^datatypeWithEnum}}{{classname}}{{/datatypeWithEnum}}.{{name}};
62+
63+
{{/enumVars}}
64+
{{/allowableValues}}
65+
throw new NotImplementedException($"Could not convert value to type {{datatypeWithEnum}}{{^datatypeWithEnum}}{{classname}}{{/datatypeWithEnum}}: '{value}'");
66+
}
67+
68+
/// <summary>
69+
/// Parses a given value to <see cref="{{datatypeWithEnum}}{{^datatypeWithEnum}}{{classname}}{{/datatypeWithEnum}}"/>
70+
/// </summary>
71+
/// <param name="value"></param>
72+
/// <returns></returns>
73+
public static {{datatypeWithEnum}}{{^datatypeWithEnum}}{{classname}}{{/datatypeWithEnum}}? FromStringOrDefault(string value)
74+
{
75+
{{#allowableValues}}
76+
{{#enumVars}}
77+
if (value.Equals({{^isString}}({{{value}}}).ToString(){{/isString}}{{#isString}}"{{{value}}}"{{/isString}}))
78+
return {{datatypeWithEnum}}{{^datatypeWithEnum}}{{classname}}{{/datatypeWithEnum}}.{{name}};
79+
80+
{{/enumVars}}
81+
{{/allowableValues}}
82+
return null;
83+
}
84+
85+
/// <summary>
86+
/// Converts the <see cref="{{datatypeWithEnum}}{{^datatypeWithEnum}}{{classname}}{{/datatypeWithEnum}}"/> to the json value
87+
/// </summary>
88+
/// <param name="value"></param>
89+
/// <returns></returns>
90+
/// <exception cref="NotImplementedException"></exception>
91+
public static {{>EnumValueDataType}} ToJsonValue({{datatypeWithEnum}}{{^datatypeWithEnum}}{{classname}}{{/datatypeWithEnum}} value)
92+
{
93+
{{^isString}}
94+
return ({{>EnumValueDataType}}) value;
95+
{{/isString}}
96+
{{#isString}}
97+
{{#allowableValues}}
98+
{{#enumVars}}
99+
if (value == {{datatypeWithEnum}}{{^datatypeWithEnum}}{{classname}}{{/datatypeWithEnum}}.{{name}})
100+
return {{^isNumeric}}"{{/isNumeric}}{{{value}}}{{^isNumeric}}"{{/isNumeric}};
101+
102+
{{/enumVars}}
103+
{{/allowableValues}}
104+
throw new NotImplementedException($"Value could not be handled: '{value}'");
105+
{{/isString}}
106+
}
107+
}
108+
109+
/// <summary>
110+
/// A Json converter for type <see cref="{{datatypeWithEnum}}{{^datatypeWithEnum}}{{classname}}{{/datatypeWithEnum}}"/>
111+
/// </summary>
112+
/// <exception cref="NotImplementedException"></exception>
113+
public class {{datatypeWithEnum}}{{^datatypeWithEnum}}{{classname}}{{/datatypeWithEnum}}JsonConverter : JsonConverter<{{datatypeWithEnum}}{{^datatypeWithEnum}}{{classname}}{{/datatypeWithEnum}}>
114+
{
115+
/// <summary>
116+
/// Returns a {{datatypeWithEnum}} from the Json object
117+
/// </summary>
118+
/// <param name="reader"></param>
119+
/// <param name="typeToConvert"></param>
120+
/// <param name="options"></param>
121+
/// <returns></returns>
122+
public override {{datatypeWithEnum}}{{^datatypeWithEnum}}{{classname}}{{/datatypeWithEnum}} Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options)
123+
{
124+
string{{nrt?}} rawValue = reader.GetString();
125+
126+
{{datatypeWithEnum}}{{^datatypeWithEnum}}{{classname}}{{/datatypeWithEnum}}? result = rawValue == null
127+
? null
128+
: {{datatypeWithEnum}}{{^datatypeWithEnum}}{{classname}}{{/datatypeWithEnum}}ValueConverter.FromStringOrDefault(rawValue);
129+
130+
if (result != null)
131+
return result.Value;
132+
133+
throw new JsonException();
134+
}
135+
136+
/// <summary>
137+
/// Writes the {{datatypeWithEnum}}{{^datatypeWithEnum}}{{classname}}{{/datatypeWithEnum}} to the json writer
138+
/// </summary>
139+
/// <param name="writer"></param>
140+
/// <param name="{{#lambda.camelcase_sanitize_param}}{{datatypeWithEnum}}{{^datatypeWithEnum}}{{classname}}{{/datatypeWithEnum}}{{/lambda.camelcase_sanitize_param}}"></param>
141+
/// <param name="options"></param>
142+
public override void Write(Utf8JsonWriter writer, {{datatypeWithEnum}}{{^datatypeWithEnum}}{{classname}}{{/datatypeWithEnum}} {{#lambda.camelcase_sanitize_param}}{{datatypeWithEnum}}{{^datatypeWithEnum}}{{classname}}{{/datatypeWithEnum}}{{/lambda.camelcase_sanitize_param}}, JsonSerializerOptions options)
143+
{
144+
writer.WriteStringValue({{datatypeWithEnum}}{{^datatypeWithEnum}}{{classname}}{{/datatypeWithEnum}}ValueConverter.ToJsonValue({{#lambda.camelcase_sanitize_param}}{{datatypeWithEnum}}{{^datatypeWithEnum}}{{classname}}{{/datatypeWithEnum}}{{/lambda.camelcase_sanitize_param}}).ToString());
145+
}
146+
}
147+
148+
/// <summary>
149+
/// A Json converter for type <see cref="{{datatypeWithEnum}}{{^datatypeWithEnum}}{{classname}}{{/datatypeWithEnum}}"/>
150+
/// </summary>
151+
public class {{datatypeWithEnum}}{{^datatypeWithEnum}}{{classname}}{{/datatypeWithEnum}}NullableJsonConverter : JsonConverter<{{datatypeWithEnum}}{{^datatypeWithEnum}}{{classname}}{{/datatypeWithEnum}}?>
152+
{
153+
/// <summary>
154+
/// Returns a {{datatypeWithEnum}}{{^datatypeWithEnum}}{{classname}}{{/datatypeWithEnum}} from the Json object
155+
/// </summary>
156+
/// <param name="reader"></param>
157+
/// <param name="typeToConvert"></param>
158+
/// <param name="options"></param>
159+
/// <returns></returns>
160+
public override {{datatypeWithEnum}}{{^datatypeWithEnum}}{{classname}}{{/datatypeWithEnum}}? Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options)
161+
{
162+
string{{nrt?}} rawValue = reader.GetString();
163+
164+
{{datatypeWithEnum}}{{^datatypeWithEnum}}{{classname}}{{/datatypeWithEnum}}? result = rawValue == null
165+
? null
166+
: {{datatypeWithEnum}}{{^datatypeWithEnum}}{{classname}}{{/datatypeWithEnum}}ValueConverter.FromStringOrDefault(rawValue);
167+
168+
if (result != null)
169+
return result.Value;
170+
171+
throw new JsonException();
172+
}
173+
174+
/// <summary>
175+
/// Writes the {{datatypeWithEnum}}{{^datatypeWithEnum}}{{classname}}{{/datatypeWithEnum}} to the json writer
176+
/// </summary>
177+
/// <param name="writer"></param>
178+
/// <param name="{{#lambda.camelcase_sanitize_param}}{{datatypeWithEnum}}{{^datatypeWithEnum}}{{classname}}{{/datatypeWithEnum}}{{/lambda.camelcase_sanitize_param}}"></param>
179+
/// <param name="options"></param>
180+
public override void Write(Utf8JsonWriter writer, {{datatypeWithEnum}}{{^datatypeWithEnum}}{{classname}}{{/datatypeWithEnum}}? {{#lambda.camelcase_sanitize_param}}{{datatypeWithEnum}}{{^datatypeWithEnum}}{{classname}}{{/datatypeWithEnum}}{{/lambda.camelcase_sanitize_param}}, JsonSerializerOptions options)
181+
{
182+
writer.WriteStringValue({{#lambda.camelcase_sanitize_param}}{{datatypeWithEnum}}{{^datatypeWithEnum}}{{classname}}{{/datatypeWithEnum}}{{/lambda.camelcase_sanitize_param}}.HasValue ? {{datatypeWithEnum}}{{^datatypeWithEnum}}{{classname}}{{/datatypeWithEnum}}ValueConverter.ToJsonValue({{#lambda.camelcase_sanitize_param}}{{datatypeWithEnum}}{{^datatypeWithEnum}}{{classname}}{{/datatypeWithEnum}}{{/lambda.camelcase_sanitize_param}}.Value).ToString() : "null");
183+
}
184+
}
185+
{{/useGenericHost}}

0 commit comments

Comments
 (0)