Kontent.Ai.ModelGenerator.Core 10.0.0

Kontent.ai model generator utility for .NET

This utility generates strongly-typed record-based models for the Kontent.ai Delivery SDK for .NET (v19+).

What's New in Updated Delivery Models

The generated models use modern C# features and patterns:

• Records - Immutable record types with { get; init; } accessors
• Modern types - RichTextContent, Asset, TaxonomyTerm, IEmbeddedContent
• Partial records - Easily extendable without modifying generated code
• ContentTypeCodename attribute - For source-generated TypeProvider discovery

Installation & Usage

.NET Tool (Recommended)

The recommended way of obtaining this tool is installing it as a .NET Tool. You can install it as a global tool or per project as a local tool.

Global Tool

dotnet tool install -g Kontent.Ai.ModelGenerator

KontentModelGenerator --environmentId "<environmentId>" \
    [--namespace "<custom-namespace>"] \
    [--outputdir "<output-directory>"] \
    [--baseclass "<base-class-name>"]

Local Tool

dotnet new tool-manifest
dotnet tool install Kontent.Ai.ModelGenerator

dotnet tool run KontentModelGenerator --environmentId "<environmentId>" \
    [--namespace "<custom-namespace>"] \
    [--outputdir "<output-directory>"] \
    [--baseclass "<base-class-name>"]

Standalone apps for Windows, Linux, macOS

Self-contained apps are an ideal choice for machines without any version of .NET installed.

Latest release: Download

<details> <summary>Building a self-contained binary for a specific platform</summary>

• Clone the repository
• Navigate to src/Kontent.Ai.ModelGenerator
• dotnet build -r <RID> to build (see the list of all RIDs)
• dotnet publish -c release -r <RID> to publish

</details>

Parameters

CLI Syntax

Short keys such as -n "MyModels" are interchangeable with the long keys --namespace "MyModels". Other possible syntax is -n=MyModels or --namespace=MyModels. Parameter values are case-insensitive. To see all aspects of the syntax, see the MS docs.

Config file

These parameters can also be set via the appSettings.json file located in the same directory as the executable file. Command-line parameters always take precedence.

Advanced configuration (Preview API, Secure API)

There are two ways of configuring advanced Delivery SDK options (such as secure API access, preview API access, and others):

1. Command-line arguments:

   --DeliveryOptions:UseSecureAccess true --DeliveryOptions:SecureAccessApiKey <SecuredApiKey>
   

2. appSettings.json - suitable for the standalone app release

Generated Model Example

Generated file: Article.cs

// <auto-generated>
// This code was generated by Kontent.ai model generator tool
// (see https://github.com/kontent-ai/model-generator-net).
//
// Changes to this file may cause incorrect behavior and will be lost if the code is regenerated.
// To extend this record, create a separate partial record with the same name.
// </auto-generated>

using System.Collections.Generic;
using System.Text.Json.Serialization;
using Kontent.Ai.Delivery.Abstractions;
using Kontent.Ai.Delivery.Attributes;
using Kontent.Ai.Delivery.ContentItems;
using Kontent.Ai.Delivery.ContentItems.RichText;
using Kontent.Ai.Delivery.SharedModels;

namespace KontentAiModels;

[ContentTypeCodename("article")]
public partial record Article
{
    public const string BodyCopyCodename = "body_copy";
    public const string CustomTrackingCodeCodename = "custom_tracking_code";
    public const string PersonasCodename = "personas";
    public const string PostDateCodename = "post_date";
    public const string RelatedArticlesCodename = "related_articles";
    public const string TeaserImageCodename = "teaser_image";
    public const string TitleCodename = "title";
    public const string UrlPatternCodename = "url_pattern";

    [JsonPropertyName("body_copy")]
    public RichTextContent? BodyCopy { get; init; }
    [JsonPropertyName("custom_tracking_code")]
    public string? CustomTrackingCode { get; init; }
    [JsonPropertyName("personas")]
    public IEnumerable<TaxonomyTerm>? Personas { get; init; }
    [JsonPropertyName("post_date")]
    public DateTimeContent? PostDate { get; init; }
    [JsonPropertyName("related_articles")]
    public IEnumerable<IEmbeddedContent>? RelatedArticles { get; init; }
    [JsonPropertyName("teaser_image")]
    public IEnumerable<Asset>? TeaserImage { get; init; }
    [JsonPropertyName("title")]
    public string? Title { get; init; }
    [JsonPropertyName("url_pattern")]
    public string? UrlPattern { get; init; }
}

Customizing Generated Models

Since the generated models are partial records, you can extend them by creating your own partial record file:

Generated file: Article.cs (auto-generated)

namespace KontentAiModels;

[ContentTypeCodename("article")]
public partial record Article
{
    public const string TitleCodename = "title";
    // ... other constants and properties
    [JsonPropertyName("title")]
    public string? Title { get; init; }
}

Your custom file: Article.Custom.cs (your customizations)

namespace KontentAiModels;

public partial record Article
{
    // Add computed properties
    public string Slug => Title?.ToLowerInvariant().Replace(" ", "-") ?? string.Empty;

    // Add custom methods
    public bool IsPublished() => PostDate is { DateTime: var dt } && dt <= DateTime.Now;

    // Add validation
    public bool IsValid() => !string.IsNullOrEmpty(Title) && BodyCopy != null;
}

The generator creates the base model, and you maintain customizations in separate files that won't be overwritten.

Need Management SDK or Legacy Delivery SDK Support?

Feedback & Contributing

Found a bug or have a feature request? Open an issue. Pull requests are welcome!

Wall of Fame

We would like to express our thanks to the following people who contributed and made the project possible:

• Drazen Janjicek - EXLRT
• Kashif Jamal Soofi
• Casey Brown

License

MIT