Welcome to Ocelot 23.2

Thanks for taking a look at the Ocelot documentation! Please use the left hand navigation to get around. The team would suggest taking a look at the Introduction chapter first.

All Features are arranged in alphabetical order. The main features are Configuration and Routing.

We do follow development process which is described in Release Process.

Release Notes

Release Tag: 23.2.0

Release Codename: Lunar Eclipse

What’s new?

• Configuration: A brand new Merging files to memory 2 by @ebjornset as a part of the Merging Configuration Files feature.

  The AddOcelot method merges the ocelot.*.json files into a single ocelot.json file as the primary configuration file, which is written back to disk and then added to the IConfigurationBuilder for the well-known IConfiguration. You can now call another AddOcelot method that adds the merged JSON directly from memory to the IConfigurationBuilder, using AddJsonStream instead.

  See more details in Configuration Overview of Dependency Injection.

• Service Fabric: Published old undocumented Placeholders in Service Name 1 feature of Service Fabric service discovery provider.

  This feature by @FelixBoers is available starting from version 13.0.0.

• Quality of Service: A brand new Polly v8 pipelines Extensibility 3 feature by @RaynaldM

Focus On

Updates of the features

• Configuration: New Merging files to memory 2 feature by @ebjornset

• Dependency Injection: Added new overloaded AddOcelot methods by @ebjornset

• Quality of Service: Support of new Polly v8 syntax and new Extensibility 3 feature by @RaynaldM

Ocelot extra packages

• Ocelot.Provider.Polly: Support of new Polly v8 syntax.

Polly 8.0+ versions introduced the concept of resilience pipelines.

All AddPolly extensions have been automatically migrated from v7 to v8.

Please note that older v7 extensions are marked with the [Obsolete] attribute and renamed using the V7 suffix. And the old v7 implementation has been moved to the v7 namespace.

See more details in Polly v7 vs v8 section of Quality of Service chapter.

Stabilization aka bug fixing

• 683 by PR 1927. Thanks to @AlyHKafoury!

  New rules have been added to Ocelot’s configuration validation logic to find duplicate placeholders in path templates.

  See more in the FileConfigurationFluentValidator class.

• 1518 hotfix by PR 1986. Thanks to @ArwynFr!

  Using the default IServiceCollection DI extensions to register Ocelot services resulted in the ServiceCollection provider being forced to be created by calling BuildServiceProvider().

  This resulted in problems with dependency injection libraries, or worse, causing the Ocelot app to crash!

  See more in the ServiceCollectionExtensions class.

• See all bugs of the February’24 milestone

Updated Documentation

• Configuration

• Dependency Injection

• Quality of Service

• Service Fabric