HTTP interface for adding, deleting, modifying and querying

[LikeScientist]

Is there any integration of related Http interface functions in this project? Or where can I find the ready-made interfaces for encapsulation?

[gumbarros]

Hello, there is a JJMasterData.WebApi project, with this project, you can expose HTTP endpoints of your data dictionaries. You can use Scalar or Swagger to expose a public API doc with all form elements using DataDictionaryDocumentTransformer.

I'm really busy these months, but soon we will re-estructure all docs and this should be clear.

[LikeScientist]

Is there a usage method for JJMasterData.WebApi? Or could you provide me with some usable code? I'm using the .NET 8 environment and the version of WebApi I'm using is 4.4.17.

[gumbarros]

Is there a usage method for JJMasterData.WebApi? Or could you provide me with some usable code? I'm using the .NET 8 environment and the version of WebApi I'm using is 4.4.17.

Try

builder.Services.Configure<Microsoft.AspNetCore.Http.Json.JsonOptions>(options =>
{
    options.SerializerOptions.PropertyNameCaseInsensitive = true;
    options.SerializerOptions.Converters.Add(new DictionaryStringObjectJsonConverter());
});
builder.Services.AddJJMasterDataWebApiServices();
            builder.Services.AddOpenApi(options =>
            {
                options.AddDocumentTransformer<DataDictionaryDocumentTransformer>(); // the magic :)
            });
///...

  app.MapOpenApi().RequireAuthorization("ApiReferencePolicy");

  app.MapScalarApiReference("/api",options =>
  {
      options.Authentication = new ScalarAuthenticationOptions
      {
          PreferredSecuritySchemes = ["Bearer"]
      };
      options.HideModels = true;
      options.PersistentAuthentication = true;
  }).RequireAuthorization("ApiReferencePolicy");

   app.MapMasterDataApi().RequireAuthorization(options =>
  {
      options.AuthenticationSchemes = [JwtBearerDefaults.AuthenticationScheme];
      options.RequireAuthenticatedUser();
      //do more policies here.
  });

I promise that soon I will document everything and make it easier to understand/use.

[gumbarros]

Also try 4.5.10

[LikeScientist]

I have updated to VS 2026 and .NET 10. The version has been updated from NuGet to 4.5.11. But how is the app defined in your code? I use var app = WebApplication.CreateBuilder(args).. Build(); However, there is no MapScalarApiReference API, and options.AuthenticationSchemes = [JwtBearerDefaults.AuthenticationScheme]; The JwtBearerDefaults has not been defined. Are there any complete test examples available?

[gumbarros]

I have updated to VS 2026 and .NET 10. The version has been updated from NuGet to 4.5.11. But how is the app defined in your code? I use var app = WebApplication.CreateBuilder(args).. Build(); However, there is no MapScalarApiReference API, and options.AuthenticationSchemes = [JwtBearerDefaults.AuthenticationScheme]; The JwtBearerDefaults has not been defined. Are there any complete test examples available?

You are creating app correctly, but you need to install Scalar nuget package and Microsoft.AspNetCore.Authentication.JwtBearer nuget

Soon I will create a complete example

[LikeScientist]

options.SerializerOptions.Converters.Add(new DictionaryStringObjectJsonConverter());
options.SerializerOptions.Converters property is read-only and cannot be added to.

[LikeScientist]

After running the latest version 4.5.12, if you encounter the following log error when accessing DataDictionary/Element/Index, how can it be resolved：
info: Microsoft.Hosting.Lifetime[14]
Now listening on: https://localhost:7261
info: Microsoft.Hosting.Lifetime[14]
Now listening on: http://localhost:5211
info: Microsoft.Hosting.Lifetime[0]
Application started. Press Ctrl+C to shut down.
info: Microsoft.Hosting.Lifetime[0]
Hosting environment: Development
info: Microsoft.Hosting.Lifetime[0]
Content root path: A:\Project\Work\Unity\26\SelfDisciplineAttendanceSystem.Server\JJMasterDataTest
warn: Microsoft.AspNetCore.Session.SessionMiddleware[7]
Error unprotecting the session cookie.
System.Security.Cryptography.CryptographicException: The payload was invalid. For more information go to https://aka.ms/aspnet/dataprotectionwarning
at Microsoft.AspNetCore.DataProtection.Cng.CbcAuthenticatedEncryptor.DecryptImpl(Byte* pbCiphertext, UInt32 cbCiphertext, Byte* pbAdditionalAuthenticatedData, UInt32 cbAdditionalAuthenticatedData)
at Microsoft.AspNetCore.DataProtection.Cng.Internal.CngAuthenticatedEncryptorBase.Decrypt(ArraySegment1 ciphertext, ArraySegment1 additionalAuthenticatedData)
at Microsoft.AspNetCore.DataProtection.KeyManagement.KeyRingBasedDataProtector.UnprotectCore(Byte[] protectedData, Boolean allowOperationsOnRevokedKeys, UnprotectStatus& status)
at Microsoft.AspNetCore.DataProtection.KeyManagement.KeyRingBasedDataProtector.Unprotect(Byte[] protectedData)
at Microsoft.AspNetCore.Session.CookieProtection.Unprotect(IDataProtector protector, String protectedText, ILogger logger)
warn: Microsoft.AspNetCore.Session.SessionMiddleware[7]
Error unprotecting the session cookie.
System.Security.Cryptography.CryptographicException: The payload was invalid. For more information go to https://aka.ms/aspnet/dataprotectionwarning
at Microsoft.AspNetCore.DataProtection.Cng.CbcAuthenticatedEncryptor.DecryptImpl(Byte* pbCiphertext, UInt32 cbCiphertext, Byte* pbAdditionalAuthenticatedData, UInt32 cbAdditionalAuthenticatedData)
at Microsoft.AspNetCore.DataProtection.Cng.Internal.CngAuthenticatedEncryptorBase.Decrypt(ArraySegment1 ciphertext, ArraySegment1 additionalAuthenticatedData)
at Microsoft.AspNetCore.DataProtection.KeyManagement.KeyRingBasedDataProtector.UnprotectCore(Byte[] protectedData, Boolean allowOperationsOnRevokedKeys, UnprotectStatus& status)
at Microsoft.AspNetCore.DataProtection.KeyManagement.KeyRingBasedDataProtector.Unprotect(Byte[] protectedData)
at Microsoft.AspNetCore.Session.CookieProtection.Unprotect(IDataProtector protector, String protectedText, ILogger logger)
info: JJMasterData.Commons.Data.Entity.Repository.EntityRepository[0]
Executing GET command for element MasterData.
fail: Microsoft.AspNetCore.Diagnostics.DeveloperExceptionPageMiddleware[1]
An unhandled exception has occurred while executing the request.
System.ArgumentNullException: Value cannot be null. (Parameter 'name')
at System.ArgumentNullException.Throw(String paramName)
at System.ArgumentNullException.ThrowIfNull(Object argument, String paramName)
at Microsoft.Extensions.Localization.StringLocalizer1.get_Item(String name) at JJMasterData.Core.UI.Components.JJCheckBox.<>c__DisplayClass24_0.<GetInputHtml>b__3(HtmlBuilder label) at JJConsulting.Html.Extensions.HtmlBuilderAppendExtensions.Append(HtmlBuilder htmlBuilder, HtmlTag tag, Action1 builderAction)
at JJConsulting.Html.Extensions.HtmlBuilderAppendExtensions.AppendIf(HtmlBuilder htmlBuilder, Boolean condition, HtmlTag tag, Action1 builderAction) at JJMasterData.Core.UI.Components.JJCheckBox.GetInputHtml() at JJMasterData.Core.UI.Components.JJCheckBox.GetHtmlBuilder() at JJMasterData.Core.UI.Components.GridSettingsForm.GetDataToggleElement(String name, String label, Boolean isChecked) at JJMasterData.Core.UI.Components.GridSettingsForm.GetShowBorderHtml(GridSettings gridSettings) at JJMasterData.Core.UI.Components.GridSettingsForm.<>c__DisplayClass12_0.<GetHtmlBuilder>b__1(HtmlBuilder div) at JJConsulting.Html.Extensions.HtmlBuilderAppendExtensions.Append(HtmlBuilder htmlBuilder, HtmlTag tag, Action1 builderAction)
at JJConsulting.Html.Extensions.HtmlBuilderAppendExtensions.AppendDiv(HtmlBuilder htmlBuilder, Action1 builderAction) at JJMasterData.Core.UI.Components.GridSettingsForm.GetHtmlBuilder(Boolean isPaginationEnabled, GridSettings gridSettings) at JJMasterData.Core.UI.Components.JJGridView.GetSettingsHtml() at JJMasterData.Core.UI.Components.JJGridView.GetTableHtmlBuilder() at JJMasterData.Core.UI.Components.JJGridView.GetHtmlBuilderAsync() at JJMasterData.Core.UI.Components.JJGridView.BuildResultAsync() at JJMasterData.Core.UI.Components.JJFormView.GetDefaultResult(Dictionary2 formValues)
at JJMasterData.Core.UI.Components.JJFormView.GetFormActionResult()
at JJMasterData.Core.UI.Components.JJFormView.GetFormResultAsync()
at JJMasterData.Core.UI.Components.JJFormView.BuildResultAsync()
at JJMasterData.Web.Areas.DataDictionary.Controllers.ElementController.Index()
at Microsoft.AspNetCore.Mvc.Infrastructure.ActionMethodExecutor.TaskOfIActionResultExecutor.Execute(ActionContext actionContext, IActionResultTypeMapper mapper, ObjectMethodExecutor executor, Object controller, Object[] arguments)
at Microsoft.AspNetCore.Mvc.Infrastructure.ControllerActionInvoker.g__Awaited|12_0(ControllerActionInvoker invoker, ValueTask`1 actionResultValueTask)
at Microsoft.AspNetCore.Mvc.Infrastructure.ControllerActionInvoker.g__Awaited|10_0(ControllerActionInvoker invoker, Task lastTask, State next, Scope scope, Object state, Boolean isCompleted)
at Microsoft.AspNetCore.Mvc.Infrastructure.ControllerActionInvoker.Rethrow(ActionExecutedContextSealed context)
at Microsoft.AspNetCore.Mvc.Infrastructure.ControllerActionInvoker.Next(State& next, Scope& scope, Object& state, Boolean& isCompleted)
at Microsoft.AspNetCore.Mvc.Infrastructure.ControllerActionInvoker.g__Awaited|13_0(ControllerActionInvoker invoker, Task lastTask, State next, Scope scope, Object state, Boolean isCompleted)
at Microsoft.AspNetCore.Mvc.Infrastructure.ResourceInvoker.g__Awaited|25_0(ResourceInvoker invoker, Task lastTask, State next, Scope scope, Object state, Boolean isCompleted)
at Microsoft.AspNetCore.Mvc.Infrastructure.ResourceInvoker.Rethrow(ResourceExecutedContextSealed context)
at Microsoft.AspNetCore.Mvc.Infrastructure.ResourceInvoker.Next(State& next, Scope& scope, Object& state, Boolean& isCompleted)
at Microsoft.AspNetCore.Mvc.Infrastructure.ResourceInvoker.g__Awaited|20_0(ResourceInvoker invoker, Task lastTask, State next, Scope scope, Object state, Boolean isCompleted)
at Microsoft.AspNetCore.Mvc.Infrastructure.ResourceInvoker.g__Awaited|17_0(ResourceInvoker invoker, Task task, IDisposable scope)
at Microsoft.AspNetCore.Mvc.Infrastructure.ResourceInvoker.g__Awaited|17_0(ResourceInvoker invoker, Task task, IDisposable scope)
at Microsoft.AspNetCore.Session.SessionMiddleware.Invoke(HttpContext context)
at Microsoft.AspNetCore.Session.SessionMiddleware.Invoke(HttpContext context)
at Microsoft.AspNetCore.Authorization.AuthorizationMiddleware.Invoke(HttpContext context)
at Microsoft.AspNetCore.Authentication.AuthenticationMiddleware.Invoke(HttpContext context)
at Microsoft.AspNetCore.Diagnostics.DeveloperExceptionPageMiddlewareImpl.Invoke(HttpContext context)

[LikeScientist]

After running the latest version 4.5.12, if you encounter the following log error when accessing DataDictionary/Element/Index, how can it be resolved：
info: Microsoft.Hosting.Lifetime[14]
Now listening on: https://localhost:7261
info: Microsoft.Hosting.Lifetime[14]
Now listening on: http://localhost:5211
info: Microsoft.Hosting.Lifetime[0]
Application started. Press Ctrl+C to shut down.
info: Microsoft.Hosting.Lifetime[0]
Hosting environment: Development
info: Microsoft.Hosting.Lifetime[0]
Content root path: A:\Project\Work\Unity\26\SelfDisciplineAttendanceSystem.Server\JJMasterDataTest
warn: Microsoft.AspNetCore.Session.SessionMiddleware[7]
Error unprotecting the session cookie.
System.Security.Cryptography.CryptographicException: The payload was invalid. For more information go to https://aka.ms/aspnet/dataprotectionwarning
at Microsoft.AspNetCore.DataProtection.Cng.CbcAuthenticatedEncryptor.DecryptImpl(Byte* pbCiphertext, UInt32 cbCiphertext, Byte* pbAdditionalAuthenticatedData, UInt32 cbAdditionalAuthenticatedData)
at Microsoft.AspNetCore.DataProtection.Cng.Internal.CngAuthenticatedEncryptorBase.Decrypt(ArraySegment1 ciphertext, ArraySegment1 additionalAuthenticatedData)
at Microsoft.AspNetCore.DataProtection.KeyManagement.KeyRingBasedDataProtector.UnprotectCore(Byte[] protectedData, Boolean allowOperationsOnRevokedKeys, UnprotectStatus& status)
at Microsoft.AspNetCore.DataProtection.KeyManagement.KeyRingBasedDataProtector.Unprotect(Byte[] protectedData)
at Microsoft.AspNetCore.Session.CookieProtection.Unprotect(IDataProtector protector, String protectedText, ILogger logger)
warn: Microsoft.AspNetCore.Session.SessionMiddleware[7]
Error unprotecting the session cookie.
System.Security.Cryptography.CryptographicException: The payload was invalid. For more information go to https://aka.ms/aspnet/dataprotectionwarning
at Microsoft.AspNetCore.DataProtection.Cng.CbcAuthenticatedEncryptor.DecryptImpl(Byte* pbCiphertext, UInt32 cbCiphertext, Byte* pbAdditionalAuthenticatedData, UInt32 cbAdditionalAuthenticatedData)
at Microsoft.AspNetCore.DataProtection.Cng.Internal.CngAuthenticatedEncryptorBase.Decrypt(ArraySegment1 ciphertext, ArraySegment1 additionalAuthenticatedData)
at Microsoft.AspNetCore.DataProtection.KeyManagement.KeyRingBasedDataProtector.UnprotectCore(Byte[] protectedData, Boolean allowOperationsOnRevokedKeys, UnprotectStatus& status)
at Microsoft.AspNetCore.DataProtection.KeyManagement.KeyRingBasedDataProtector.Unprotect(Byte[] protectedData)
at Microsoft.AspNetCore.Session.CookieProtection.Unprotect(IDataProtector protector, String protectedText, ILogger logger)
info: JJMasterData.Commons.Data.Entity.Repository.EntityRepository[0]
Executing GET command for element MasterData.
fail: Microsoft.AspNetCore.Diagnostics.DeveloperExceptionPageMiddleware[1]
An unhandled exception has occurred while executing the request.
System.ArgumentNullException: Value cannot be null. (Parameter 'name')
at System.ArgumentNullException.Throw(String paramName)
at System.ArgumentNullException.ThrowIfNull(Object argument, String paramName)
at Microsoft.Extensions.Localization.StringLocalizer1.get_Item(String name) at JJMasterData.Core.UI.Components.JJCheckBox.<>c__DisplayClass24_0.<GetInputHtml>b__3(HtmlBuilder label) at JJConsulting.Html.Extensions.HtmlBuilderAppendExtensions.Append(HtmlBuilder htmlBuilder, HtmlTag tag, Action1 builderAction)
at JJConsulting.Html.Extensions.HtmlBuilderAppendExtensions.AppendIf(HtmlBuilder htmlBuilder, Boolean condition, HtmlTag tag, Action1 builderAction) at JJMasterData.Core.UI.Components.JJCheckBox.GetInputHtml() at JJMasterData.Core.UI.Components.JJCheckBox.GetHtmlBuilder() at JJMasterData.Core.UI.Components.GridSettingsForm.GetDataToggleElement(String name, String label, Boolean isChecked) at JJMasterData.Core.UI.Components.GridSettingsForm.GetShowBorderHtml(GridSettings gridSettings) at JJMasterData.Core.UI.Components.GridSettingsForm.<>c__DisplayClass12_0.<GetHtmlBuilder>b__1(HtmlBuilder div) at JJConsulting.Html.Extensions.HtmlBuilderAppendExtensions.Append(HtmlBuilder htmlBuilder, HtmlTag tag, Action1 builderAction)
at JJConsulting.Html.Extensions.HtmlBuilderAppendExtensions.AppendDiv(HtmlBuilder htmlBuilder, Action1 builderAction) at JJMasterData.Core.UI.Components.GridSettingsForm.GetHtmlBuilder(Boolean isPaginationEnabled, GridSettings gridSettings) at JJMasterData.Core.UI.Components.JJGridView.GetSettingsHtml() at JJMasterData.Core.UI.Components.JJGridView.GetTableHtmlBuilder() at JJMasterData.Core.UI.Components.JJGridView.GetHtmlBuilderAsync() at JJMasterData.Core.UI.Components.JJGridView.BuildResultAsync() at JJMasterData.Core.UI.Components.JJFormView.GetDefaultResult(Dictionary2 formValues)
at JJMasterData.Core.UI.Components.JJFormView.GetFormActionResult()
at JJMasterData.Core.UI.Components.JJFormView.GetFormResultAsync()
at JJMasterData.Core.UI.Components.JJFormView.BuildResultAsync()
at JJMasterData.Web.Areas.DataDictionary.Controllers.ElementController.Index()
at Microsoft.AspNetCore.Mvc.Infrastructure.ActionMethodExecutor.TaskOfIActionResultExecutor.Execute(ActionContext actionContext, IActionResultTypeMapper mapper, ObjectMethodExecutor executor, Object controller, Object[] arguments)
at Microsoft.AspNetCore.Mvc.Infrastructure.ControllerActionInvoker.g__Awaited|12_0(ControllerActionInvoker invoker, ValueTask`1 actionResultValueTask)
at Microsoft.AspNetCore.Mvc.Infrastructure.ControllerActionInvoker.g__Awaited|10_0(ControllerActionInvoker invoker, Task lastTask, State next, Scope scope, Object state, Boolean isCompleted)
at Microsoft.AspNetCore.Mvc.Infrastructure.ControllerActionInvoker.Rethrow(ActionExecutedContextSealed context)
at Microsoft.AspNetCore.Mvc.Infrastructure.ControllerActionInvoker.Next(State& next, Scope& scope, Object& state, Boolean& isCompleted)
at Microsoft.AspNetCore.Mvc.Infrastructure.ControllerActionInvoker.g__Awaited|13_0(ControllerActionInvoker invoker, Task lastTask, State next, Scope scope, Object state, Boolean isCompleted)
at Microsoft.AspNetCore.Mvc.Infrastructure.ResourceInvoker.g__Awaited|25_0(ResourceInvoker invoker, Task lastTask, State next, Scope scope, Object state, Boolean isCompleted)
at Microsoft.AspNetCore.Mvc.Infrastructure.ResourceInvoker.Rethrow(ResourceExecutedContextSealed context)
at Microsoft.AspNetCore.Mvc.Infrastructure.ResourceInvoker.Next(State& next, Scope& scope, Object& state, Boolean& isCompleted)
at Microsoft.AspNetCore.Mvc.Infrastructure.ResourceInvoker.g__Awaited|20_0(ResourceInvoker invoker, Task lastTask, State next, Scope scope, Object state, Boolean isCompleted)
at Microsoft.AspNetCore.Mvc.Infrastructure.ResourceInvoker.g__Awaited|17_0(ResourceInvoker invoker, Task task, IDisposable scope)
at Microsoft.AspNetCore.Mvc.Infrastructure.ResourceInvoker.g__Awaited|17_0(ResourceInvoker invoker, Task task, IDisposable scope)
at Microsoft.AspNetCore.Session.SessionMiddleware.Invoke(HttpContext context)
at Microsoft.AspNetCore.Session.SessionMiddleware.Invoke(HttpContext context)
at Microsoft.AspNetCore.Authorization.AuthorizationMiddleware.Invoke(HttpContext context)
at Microsoft.AspNetCore.Authentication.AuthenticationMiddleware.Invoke(HttpContext context)
at Microsoft.AspNetCore.Diagnostics.DeveloperExceptionPageMiddlewareImpl.Invoke(HttpContext context)