DragonFly.API.Core 1.0.22

dotnet add package DragonFly.API.Core --version 1.0.22                
NuGet\Install-Package DragonFly.API.Core -Version 1.0.22                
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.
<PackageReference Include="DragonFly.API.Core" Version="1.0.22" />                
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add DragonFly.API.Core --version 1.0.22                
#r "nuget: DragonFly.API.Core, 1.0.22"                
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.
// Install DragonFly.API.Core as a Cake Addin
#addin nuget:?package=DragonFly.API.Core&version=1.0.22

// Install DragonFly.API.Core as a Cake Tool
#tool nuget:?package=DragonFly.API.Core&version=1.0.22                

DragonFly » Headless ASP.NET Core CMS + Blazor

License: MIT

Package Release
DragonFly.Core NuGet
DragonFly.AspNetCore NuGet
DragonFly.API NuGet
DragonFly.Client NuGet
DragonFly.Generator NuGet
DragonFly.ImageWizard NuGet
DragonFly.MongoDB NuGet
DragonFly.Identity NuGet
DragonFly.ApiKeys NuGet

Features

grafik

  • Define schema with custom fields
  • Create, update, delete and publish/unpublish content items based on schema
    • Create new Fields with FieldGenerator
  • Create typed content items with ModelGenerator
  • BlockField for structured page content
    • TextBlock, HtmlBlock, ColumnBlock, GridBlock, AssetBlock, YouTubeBlock, CodeBlock,..
  • Asset management
    • Folder tree
    • Asset metadata like ImageMetadata and PdfMetadata
      • Use IAssetProcessing after asset upload
    • Create thumbnails for image and pdf files with ImageWizard
  • REST API
  • Permissions for content, schema, asset, asset folder, webhooks
    • Dynamic permissions for every schema
  • Background tasks
  • WebHooks
  • MongoDB storage
    • Create proxies with ProxyGenerator
  • Admin interface with Blazor

Getting started

Prerequisites

Create a new project from template

To use the project template you need first to download and install it from NuGet.

dotnet new install DragonFly.Templates

After this you can create the project with:

dotnet new DragonFly

If you have a remote MongoDB instance, you need to add some appsettings:

"MongoDB": {
    "Hostname": "localhost",
    "Database": "DragonFly_App",
    "Port": 27017,
    "Username": "",
    "Password": ""
  },

Use source generators to avoid reflection

  • FieldGenerator
  • ModelGenerator
  • ProxyGenerator

Supported fields

  • StringField
  • FloatField
  • BoolField
  • AssetField
  • ReferenceField
  • ComponentField
  • ArrayField
  • DateField
  • IntegerField
  • ColorField
  • GeolocationField
  • SlugField
  • XmlField
  • HtmlField
  • BlockField (HeadingBlock, TextBlock, HtmlBlock, CodeBlock, ContainerBlock, ColumnBlock, AssetBlock, ReferenceBlock, GridBlock,..)

How to create new content schema and content item

IContentStorage contentStorage = ...;//use MongoStorage or ClientContentService (http client)

//create brand schema
ContentSchema schemaBrand = new ContentSchema("Brand")
                                    .AddString("Name")
                                    .AddSlug("Slug")
                                    .AddTextArea("Description");

//Define schema for product
ContentSchema schemaProduct = new ContentSchema("Product")
                                    .AddReference("Brand")
                                    .AddString("Name", options => options.IsRequired = true)
                                    .AddSlug("Slug")
                                    .AddBool("IsAvailable", options => options.DefaultValue = true)
                                    .AddFloat("Price")
                                    .AddTextArea("Description", options => options.MaxLength = 255)
                                    .AddArray("Attributes", options => options
                                                                        .AddString("Name")
                                                                        .AddString("Value"));

await contentStorage.CreateAsync(schemaProduct);

//create product by schema
ContentItem contentProduct = schemaProduct
                            .CreateContent()
                            .SetReference("Brand", new ContentItem(Guid.Parse(""), schemaBrand))
                            .SetString("Name", "ProductA")
                            .SetBool("IsAvailable", true)
                            .SetFloat("Price", 9.99)
                            .SetTextArea("Description", "...")
                            .AddArrayItem("Attributes", schemaProduct, item => item
                                                                    .SetString("Name", "Size")
                                                                    .SetString("Value", "M"));

await contentStorage.CreateAsync(contentProduct);

Create typed content

DragonFly.Generator

[ContentItem]
public partial class BlogPost
{
    [DateField(Required = true)]
    private DateTime? _date;

    [StringField(Required = true, Searchable = true, ListField = true, MinLength = 8, MaxLength = 512)]
    private string? _title;

    [TextField]
    private string? _description;

    [SlugField(Required = true, Index = true)]
    private string? _slug;

    [AssetField(ListField = true, ShowPreview = true)]
    private AssetField _image;

    [BlockField]
    private BlockField _mainContent;
}
Register typed content
builder.Services.AddDragonFly()
                    .AddModels(x => x.Add<BlogPost>());                    
Use queries for typed content
//get all items
var result = await ContentStorage.QueryAsync<BlogPostModel>(x => x
                                    .Published(true)
                                    .Top(10)
                                    .Slug(x => x.Slug, "my-product")
                                    .Integer(x => x.Quantity, 10, NumberQueryType.Equal)
                                    .String(x => x.Title, "Test", StringQueryType.Equal)
);

BackgroundTask

For long running jobs you can use the BackgroundTaskManager.

IBackgroundTaskManager taskManager = app.Services.GetRequiredService<IBackgroundTaskManager>();
taskManager.Start("Test", async ctx => await Task.Delay(TimeSpan.FromSeconds(60), ctx.CancellationToken));

DragonFly.AspNetCore

builder.Services.Configure<DragonFlyOptions>(Configuration.GetSection("General"));
builder.Services.Configure<MongoDbOptions>(Configuration.GetSection("MongoDB"));

//add DragonFly services
builder.Services.AddDragonFly(x => x
                      .AddImageWizard()
                      .AddRestApi()
                      .AddMongoDbStorage()
                      .AddMongoDbIdentity()
                      .AddApiKeys());

var app = builder.Build();

//init DragonFly
await app.InitDragonFlyAsync();

if (env.IsDevelopment())
{
  app.UseDeveloperExceptionPage();
  app.UseWebAssemblyDebugging();
}

app.UseDragonFly();
app.UseDragonFlyManager();
app.UseRouting();
app.Run();

DragonFly.Client (Blazor)

var builder = WebAssemblyHostBuilder.CreateDefault(args);
builder.RootComponents.Add<DragonFly.App.Client.App>("app");

//Register DragonFly components
builder.AddDragonFlyClient(x => x
                        .AddRestClient()
                        .AddIdentity()
                        .AddApiKeys());

WebAssemblyHost host = builder.Build();

await host.InitDragonFlyAsync();
await host.RunAsync();
Product Compatible and additional computed target framework versions.
.NET net9.0 is compatible. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages (5)

Showing the top 5 NuGet packages that depend on DragonFly.API.Core:

Package Downloads
DragonFly.API.Client

Headless CMS based on ASP.NET Core and Blazor

DragonFly.ApiKeys.Core

Headless CMS based on ASP.NET Core and Blazor

DragonFly.BlockField.Core

Headless CMS based on ASP.NET Core and Blazor

DragonFly.Identity.Core

Headless CMS based on ASP.NET Core and Blazor

DragonFly.API

Headless CMS based on ASP.NET Core and Blazor

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last updated
1.0.22 119 11/19/2024
1.0.21 112 11/19/2024
1.0.20 110 11/19/2024
1.0.19 119 11/18/2024
1.0.18 114 11/17/2024
1.0.17 105 11/17/2024
1.0.15 237 4/27/2024
1.0.14 236 3/19/2024
1.0.13 148 3/19/2024
1.0.12 275 3/7/2024
1.0.11 277 3/7/2024
1.0.10 263 3/6/2024
1.0.9 346 3/3/2024
1.0.8 317 2/22/2024
1.0.7 376 2/7/2024
1.0.6 426 1/18/2024
1.0.5 546 12/18/2023
1.0.4 549 12/2/2023
1.0.3 500 11/30/2023
1.0.2 508 11/30/2023
1.0.1 509 11/30/2023
0.9.32 339 8/25/2023
0.9.31 387 7/27/2023
0.9.30 360 7/27/2023
0.9.22 388 6/30/2023
0.9.20 371 6/27/2023
0.9.19 371 6/22/2023
0.9.17 402 5/9/2023
0.9.16 412 4/28/2023
0.9.15 406 4/27/2023
0.9.14 391 4/27/2023
0.9.13 410 4/15/2023
0.9.12 453 3/19/2023
0.9.11 440 3/15/2023
0.9.10 463 3/5/2023
0.9.9 481 3/3/2023
0.9.8 480 3/2/2023
0.9.7 540 1/29/2023
0.9.6 522 1/27/2023
0.9.5 530 1/25/2023
0.9.3 556 1/2/2023
0.9.2 529 1/2/2023
0.9.0 538 12/28/2022