Consul integration with serviceName prefix and ConsulClient library

[rabdulatif]

Overview:

This PR introduces several key updates related to Consul service discovery and Swagger endpoint handling within the Ocelot setup.

Changes:

1. Added MMLib.ServiceDiscovery.Consul:

   • Introduced a new project for Consul service auto-discovery.
   • This enables clients who don't define Swagger endpoints in their ocelot.json to use Consul for discovery.

2. Updated MMLib.SwaggerForOcelot in ServiceCollectionExtensions:

   • Modified the AddSwaggerForOcelot method to include conditional handling for Consul.
   • Now checks if Consul is being used, to configure Swagger appropriately.

3. Introduced ConsulSwaggerEndpointProvider:

   • This new class retrieves Swagger endpoints from Consul for clients using Consul or PollConsul as the discovery type.
   • It ensures proper Swagger integration with Consul-managed services.

Summary by CodeRabbit

• New Features

  • Introduced multiple new projects for enhanced service discovery and API management, including MMLib.ServiceDiscovery.Consul, ConsulAutoDiscovery, ConsulApiGateway, and AutoDiscoveryApi.
  • Added Swagger support for API documentation in new projects.
  • Implemented a weather forecast endpoint in the AutoDiscoveryApi.

• Bug Fixes

  • Removed outdated Ocelot package references from several projects to streamline dependencies.

• Documentation

  • New configuration files for development and production settings in AutoDiscoveryApi and ConsulApiGateway.

• Chores

  • Restructured Swagger UI configuration in the OrderService for better organization and clarity.

[update-docs[bot]]

Thanks for opening this pull request! If you have implemented new functions, write about them in the readme file.

[coderabbitai[bot]]

Walkthrough

This pull request introduces multiple new projects to the Visual Studio solution MMLib.SwaggerForOcelot.sln, specifically focusing on service discovery with Consul. It includes the creation of new projects such as MMLib.ServiceDiscovery.Consul, ConsulAutoDiscovery, ConsulApiGateway, and AutoDiscoveryApi. The changes also involve the removal of the Ocelot package from several existing projects, indicating a shift in dependency management. Additionally, new configuration files and application settings are added to support the integration of Consul for service discovery and Swagger for API documentation.

Changes

File Path	Change Summary
MMLib.SwaggerForOcelot.sln	Added new projects: MMLib.ServiceDiscovery.Consul, ConsulAutoDiscovery, ConsulApiGateway, AutoDiscoveryApi.
demo/ApiGateway/ApiGateway.csproj	Removed Ocelot package reference.
demo/ApiGatewayWithEndpointInterceptor/ApiGatewayWithEndpointInterceptor.csproj	Removed Ocelot package reference.
demo/ApiGatewayWithPath/ApiGatewayWithPath.csproj	Removed Ocelot package reference.
demo/ConsulAutoDiscovery/AutoDiscoveryApi/AutoDiscoveryApi.csproj	New project targeting .NET 8.0 with nullable reference types enabled.
demo/ConsulAutoDiscovery/AutoDiscoveryApi/Program.cs	Added ASP.NET Core configuration for Consul service discovery and Swagger setup.
demo/ConsulAutoDiscovery/AutoDiscoveryApi/appsettings.Development.json	New configuration file for logging settings.
demo/ConsulAutoDiscovery/AutoDiscoveryApi/appsettings.json	New configuration file for logging and allowed hosts.
demo/ConsulAutoDiscovery/ConsulApiGateway/ConsulApiGateway.csproj	New project targeting .NET 8.0 with references for OpenAPI and Swagger.
demo/ConsulAutoDiscovery/ConsulApiGateway/Program.cs	Introduced Ocelot API Gateway with Consul integration and Swagger support.
demo/ConsulAutoDiscovery/ConsulApiGateway/appsettings.Development.json	New configuration file for logging settings.
demo/ConsulAutoDiscovery/ConsulApiGateway/appsettings.json	New configuration file for logging and allowed hosts.
demo/ConsulAutoDiscovery/ConsulApiGateway/ocelot.json	New configuration file for Ocelot API Gateway with service discovery settings.
demo/OrderService/OrderService.csproj	Added project reference to MMLib.ServiceDiscovery.Consul.
demo/OrderService/Startup.cs	Modified Startup class for improved Swagger UI configuration.
src/MMLib.ServiceDiscovery.Consul/MMLib.ServiceDiscovery.Consul.csproj	New project targeting .NET 7.0 and .NET 8.0 with necessary package references.
src/MMLib.ServiceDiscovery.Consul/DependencyInjection/ConfigureExtensions.cs	New file with extension methods for configuring Consul and Swagger UI.

Possibly related PRs

• 308: This PR addresses an issue with the URI scheme in Swagger when using PollConsul service discovery, which is directly related to the changes made in the main PR that involve integrating Consul for service discovery.

• 310: This PR updates the GetScheme method in the SwaggerServiceDiscoveryProvider, which is relevant to the main PR's focus on service discovery and Swagger integration within the new projects.

Suggested reviewers

• Burgyn

Poem

🐰 In the meadow where rabbits play,
New projects hop in, brightening the day.
With Consul's help, we find our way,
Swagger shines, guiding our sway.
Let's celebrate this joyful array! 🌼

---

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share

- [X](https://twitter.com/intent/tweet?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A&url=https%3A//coderabbit.ai) - [Mastodon](https://mastodon.social/share?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A%20https%3A%2F%2Fcoderabbit.ai) - [Reddit](https://www.reddit.com/submit?title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&text=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code.%20Check%20it%20out%3A%20https%3A//coderabbit.ai) - [LinkedIn](https://www.linkedin.com/sharing/share-offsite/?url=https%3A%2F%2Fcoderabbit.ai&mini=true&title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&summary=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code)

🪧 Tips

### Chat There are 3 ways to chat with [CodeRabbit](https://coderabbit.ai): - Review comments: Directly reply to a review comment made by CodeRabbit. Example: - `I pushed a fix in commit , please review it.` - `Generate unit testing code for this file.` - `Open a follow-up GitHub issue for this discussion.` - Files and specific lines of code (under the "Files changed" tab): Tag `@coderabbitai` in a new review comment at the desired location with your query. Examples: - `@coderabbitai generate unit testing code for this file.` - `@coderabbitai modularize this function.` - PR comments: Tag `@coderabbitai` in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples: - `@coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.` - `@coderabbitai read src/utils.ts and generate unit testing code.` - `@coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.` - `@coderabbitai help me debug CodeRabbit configuration file.` Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. ### CodeRabbit Commands (Invoked using PR comments) - `@coderabbitai pause` to pause the reviews on a PR. - `@coderabbitai resume` to resume the paused reviews. - `@coderabbitai review` to trigger an incremental review. This is useful when automatic reviews are disabled for the repository. - `@coderabbitai full review` to do a full review from scratch and review all the files again. - `@coderabbitai summary` to regenerate the summary of the PR. - `@coderabbitai resolve` resolve all the CodeRabbit review comments. - `@coderabbitai configuration` to show the current CodeRabbit configuration for the repository. - `@coderabbitai help` to get help. ### Other keywords and placeholders - Add `@coderabbitai ignore` anywhere in the PR description to prevent this PR from being reviewed. - Add `@coderabbitai summary` to generate the high-level summary at a specific location in the PR description. - Add `@coderabbitai` anywhere in the PR title to generate the title automatically. ### CodeRabbit Configuration File (`.coderabbit.yaml`) - You can programmatically configure CodeRabbit by adding a `.coderabbit.yaml` file to the root of your repository. - Please see the [configuration documentation](https://docs.coderabbit.ai/guides/configure-coderabbit) for more information. - If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: `# yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json` ### Documentation and Community - Visit our [Documentation](https://coderabbit.ai/docs) for detailed information on how to use CodeRabbit. - Join our [Discord Community](http://discord.gg/coderabbit) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.

[rabdulatif]

312