Getting Started With The C# Middleware API

Endpoints are added to an ASP.NET Core web app project when the Directscale Middleware is added. These endpoints help with the logistic operations of Hosting a Client Web Application

Auto-Configuration


Endpoints are added to allow the logistical operations of Configuring a Client Web Application when deploying a Client Web Application programmatically.

The following endpoints can be used to Configuring a Client Web Application.

Two-Step Configuration Process

👍

Using The Client Extension?

The Client Extension uses the two-step configuration to automatically update configurations during a deployment. Learn more by reading about Deploying The Client Extension

Using these two endpoints allows a new version to be deployed with no downtime.

Call this endpoint on a new version of code before traffic is sent to it. This avoids errors by making sure any endpoints that no longer exist are not configured to be called.

Call this endpoint on the new version of code after traffic is sent to it. This avoids errors by making sure any endpoints that did not exist until the new version was deployed were not configured to be called until it was fully deployed.

Alternate Configuration Process

If the Two-Step Configuration process does not work for your deployment strategy you may want to use the Get Routes Endpoint. This endpoint provides all the relative paths that must be configured with Directscale for the customizations written in the code to take effect. Using this information and the RegistrationService allows you to Configure a Client Web Application programatically.


Version Information


It can be helpful to know what version is actually deployed to confirm a deployment was truly successful. Use the Get Extension Version endpoint to know what version is deployed.