Skip to content

add support for dictionary models #18

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jun 3, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -66,9 +66,6 @@
}
]
},
"": {
"parameters": []
},
"/hello-generated2": {
"get": {
"summary": "HelloGenerated2",
Expand Down Expand Up @@ -171,6 +168,12 @@
},
"type": {
"$ref": "#/components/schemas/HelloType"
},
"stringsDictionary": {
"$ref": "#/components/schemas/StringsDictionary"
},
"objectsDictionary": {
"$ref": "#/components/schemas/ObjectsDictionary"
}
},
"required": [
Expand All @@ -195,6 +198,21 @@
"items": {
"$ref": "#/components/schemas/HelloFromSource"
}
},
"StringsDictionary": {
"type": "object",
"title": "Dictionary",
"description": "",
"additionalProperties": {
"type": "string"
}
},
"ObjectsDictionary": {
"type": "object",
"title": "Dictionary",
"additionalProperties": {
"$ref": "#/components/schemas/HelloFromSource"
}
}
},
"responses": {}
Expand Down
15 changes: 15 additions & 0 deletions Dojo.OpenApiGenerator/AutoApiGenerator.cs
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,7 @@ public class AutoApiGenerator : ISourceGenerator
private AutoApiGeneratorSettings _autoApiGeneratorSettings;
private string _apiConfiguratorTemplateString;
private string _apiVersionsTemplateString;
private string _dictionaryModelTemplate;

public AutoApiGenerator()
{
Expand Down Expand Up @@ -284,6 +285,10 @@ private void GenerateApiModelsSources(
{
GenerateEnum(context, apiModel, name);
}
else if (apiModel.IsDictionary)
{
GenerateDictionaryModel(context, apiModel, name);
}
else
{
GenerateApiModel(context, apiModel, name);
Expand Down Expand Up @@ -311,6 +316,16 @@ private void GenerateEnum(GeneratorExecutionContext context, ApiModel apiModel,
context.AddSource(fileName, SourceText.From(enumSource, Encoding.UTF8));
}

private void GenerateDictionaryModel(GeneratorExecutionContext context, ApiModel apiModel, string name)
{
_dictionaryModelTemplate ??= Templates.ReadTemplate(Templates.DictionaryModelTemplate);

var fileName = $"{name}.g.cs";
var dictionarySource = _stubbleBuilder.Render(_dictionaryModelTemplate, apiModel);

context.AddSource(fileName, SourceText.From(dictionarySource, Encoding.UTF8));
}

private void GenerateController(GeneratorExecutionContext context, ApiControllerDefinition data, string apiFileName)
{
_controllerTemplateString ??= Templates.ReadTemplate(Templates.AbstractController);
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
using System;
using System.CodeDom.Compiler;
using System.Collections.Generic;
using System.ComponentModel.DataAnnotations;

namespace {{Namespace}}
{
[GeneratedCode("Dojo.OpenApiGenerator", "{{AssemblyVersion}}")]
public class {{TypeName}} : Dictionary<string, {{#DictionaryValueType}}{{&TypeFullName}}{{/DictionaryValueType}}>
{
}
}
1 change: 1 addition & 0 deletions Dojo.OpenApiGenerator/CodeTemplates/Templates.cs
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@ internal static class Templates
public static string ApiVersionsTemplate => "ApiVersionsTemplate.mustache";
public static string InheritedApiVersionAttribute => "InheritedApiVersionAttribute.mustache";
public static string ApiConfiguratorTemplate => "ApiConfiguratorTemplate.mustache";
public static string DictionaryModelTemplate => "DictionaryModelTemplate.mustache";

public static string ReadTemplate(string templateName)
{
Expand Down
2 changes: 2 additions & 0 deletions Dojo.OpenApiGenerator/Dojo.OpenApiGenerator.csproj
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@
<None Remove="CodeTemplates\ApiConfiguratorTemplate.mustache" />
<None Remove="CodeTemplates\ApiConstantsTemplate.mustache" />
<None Remove="CodeTemplates\ApiVersionsTemplate.mustache" />
<None Remove="CodeTemplates\DictionaryModelTemplate.mustache" />
<None Remove="CodeTemplates\EnumTemplate.mustache" />
<None Remove="CodeTemplates\InheritedApiVersionAttribute.mustache" />
<None Remove="CodeTemplates\ModelTemplate.mustache" />
Expand All @@ -30,6 +31,7 @@
<EmbeddedResource Include="CodeTemplates\InheritedApiVersionAttribute.mustache" />
<EmbeddedResource Include="CodeTemplates\EnumTemplate.mustache" />
<EmbeddedResource Include="CodeTemplates\ApiConstantsTemplate.mustache" />
<EmbeddedResource Include="CodeTemplates\DictionaryModelTemplate.mustache" />
<EmbeddedResource Include="CodeTemplates\ServiceInterfaceTemplate.mustache" />
<EmbeddedResource Include="CodeTemplates\ModelTemplate.mustache" />
</ItemGroup>
Expand Down
21 changes: 20 additions & 1 deletion Dojo.OpenApiGenerator/Models/ApiModel.cs
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,9 @@ internal class ApiModel : ApiModelBase
public IEnumerable<ApiModelProperty> Properties { get; set; }
public bool IsCustomModel { get; set; }

public bool IsDictionary { get; set; }

public ApiModel DictionaryValueType { get; set; }

public ApiModel(
string name,
Expand All @@ -36,7 +39,16 @@ public ApiModel(
else
{
IsCustomModel = true;
Properties = openApiSchema.Properties.Select(x => new ApiModelProperty(x.Key, x.Value, openApiSchema.Required, apiModels, apiFileName, ProjectNamespace));
IsDictionary = IsDictionaryType(openApiSchema);

if (!IsDictionary)
{
Properties = openApiSchema.Properties.Select(x => new ApiModelProperty(x.Key, x.Value, openApiSchema.Required, apiModels, apiFileName, ProjectNamespace));
}
else
{
DictionaryValueType = new ApiModel(openApiSchema.AdditionalProperties, apiModels, apiFileName);
}
}
}

Expand All @@ -59,6 +71,13 @@ protected override string GetTypeFullName()
return !IsCustomModel ? base.GetTypeFullName() : $"{Namespace}.{TypeName}";
}

private static bool IsDictionaryType(OpenApiSchema openApiSchema)
{
return openApiSchema.AdditionalPropertiesAllowed &&
openApiSchema.AdditionalProperties != null &&
(openApiSchema.Properties == null || openApiSchema.Properties.Count == 0);
}

//private static void SetRequiredProperties(ApiModel apiModel, ISet<string> requiredProperties)
//{
// if (requiredProperties == null || !requiredProperties.Any())
Expand Down