#1351 #1510 New AddOcelot extensions to support custom ASP.NET MVC pipeline building via the IMvcCoreBuilder interface

[guoyongchang]

Closes #1351 #1510

• Ocelot overides System.Text.Json parser and uses Newtonsoft #1351
• Issue with default Newtonsoft Serializer #1510

Background

The default AddOcelot method adds .AddNewtonsoftJson(), which was necessary when Microsoft did not launch the System.Text.Json library, but now it affects normal use, so this PR is mainly to solve the problem problem.

默认的AddOcelot方法内部添加了.AddNewtonsoftJson()，在微软没有推出System.Text.Json库的时候是有必要的，但是现在反而影响了正常使用，所以本PR主要是解决该问题。

New Feature

Added the following methods in Ocelot.DependencyInjection.ServiceCollectionExtensions

在Ocelot.DependencyInjection.ServiceCollectionExtensions添加了以下方法

• AddOcelotWithCustomMvcCoreBuilder(this IServiceCollection services, Func<IMvcCoreBuilder, Assembly, IMvcCoreBuilder> customMvcCoreBuilder)
• AddOcelotWithCustomMvcCoreBuilder(this IServiceCollection services, IConfiguration configuration, Func<IMvcCoreBuilder, Assembly, IMvcCoreBuilder> customMvcCoreBuilder)

Proposed Changes

• Support custom MvcCoreBuilder to adapt to more changes in the future, this change is mainly to support System.Text.Json

  支持自定义MvcCoreBuilder，以适应未来更多的变化，本次更改主要是为了支持System.Text.Json

[guoyongchang]

@raman-m This PR allows users to use their desired JSON library for serialization, such as System.Text.Json.

For example:

service.AddOcelotUsingBuilder((builder, assembly) =>
{
    return builder
        .AddApplicationPart(assembly)
        .AddControllersAsServices()
        .AddAuthorization()
        .AddJsonOptions(); // use System.Text.Json
});

This is just one of the common usages, users can add more modules they need in the builder.

[raman-m]

Related to: #1515

[raman-m]

Hi @guoyongchang ! I'm just curious, what's your name?
I've made some refactoring and styling issue fixes. Hope it is useful! 😸

Could you add your user scenario from your the comment as acceptance test please, to make sure new Json lib is used?
You are welcome to show more techniques with MVC core builder.

Also, I am pleasantly asking you to add unit tests for new extension methods to files: OcelotBuilderTests
Or make new code files in the folder: DependencyInjection

[guoyongchang]

Hi @guoyongchang ! I'm just curious, what's your name? I've made some refactoring and styling issue fixes. Hope it is useful! 😸

Could you add your user scenario from your the comment as acceptance test please, to make sure new Json lib is used? You are welcome to show more techniques with MVC core builder.

Also, I am pleasantly asking you to add unit tests for new extension methods to files: OcelotBuilderTests Or make new code files in the folder: DependencyInjection

@raman-m

You can call me guo, and the name of github is my full Chinese name in pinyin. Maybe you can understand Yongchang Guo?

Nice change. I've tested it with no problems, and there will be no other confusion caused by shortened method names.

---

I think this function is usually used when integrating with existing API projects, so I put the unit test in Ocelot.IntegrationTests, which I think is more appropriate here.
If it is a pure gateway project, this extension method should not be used, and Newtonsoft.JSON can meet all the needs of users.

About more techniques with MVC core builder, I think that as long as a custom method is provided, all the default things can be overridden, for example, I only need to change the default Json Provider, maybe others need to add more assemblies, or change the default authentication.

---

Wrote into Ocelot.IntegrationTests

[raman-m]

@guoyongchang Thanks, Guo!
Good job!

[raman-m]

@geffzhang Could you review please?

[TomPallister]

Thank you for the PR, please fix the merge conflicts and update the docs so people know how to use this and I'm happy to merge!

[raman-m]

@geffzhang Geff,
Sorry for dismissing of your stale review!
Could you review and approve the PR once again please?

[raman-m]

• Merge conflicts have been resolved after updating with new top commits from develop branch
• Added new Dependency Injection feature in documentation
• Added unit tests for the OcelotBuilder class to cover AddOcelotUsingBuilder methods

[raman-m]

@TomPallister wrote on Jun 4, 2023

Thank you for the PR, please fix the merge conflicts and update the docs so people know how to use this and I'm happy to merge!

Done! See the message above plz!

Tom, could you review and merge it please?