MockResponse.Middleware.Azure.BlobStorage 8.0.1

<a id="readme-top"></a>

MockResponse.Middleware.Azure.BlobStorage

This package provides an Azure Blob Storage-backed provider for use with the MockResponse.Middleware system. It enables serving mock API responses from Azure Blob Storage, ideal for testing and shared development environments where cloud-based access is still needed.

Table of Contents

• Installation
• Configuration
• BlobStorageOptions Configuration
• Usage: AddAzureBlobStorage
• Troubleshooting

📦 Installation

dotnet add package MockResponse.Middleware.Azure.BlobStorage

<p align="right">(<a href="#readme-top">back to top</a>)</p>

⚙️ Configuration

Configure the Azure Blob Storage provider using Microsoft Secret Manager to avoid storing sensitive information in plain text files.

1. Initialize Secrets Manager for your project (if not already initialized):

dotnet user-secrets init

2. Add your Azure Blob Storage settings:

dotnet user-secrets set "MockOptions:BlobStorageOptions:ConnectionString" "<your-connection-string>"
dotnet user-secrets set "MockOptions:BlobStorageOptions:ContainerName" "<your-container-name>"

These values are securely stored in your local secrets store and accessed via IConfiguration at runtime.

3. Add additional mock configuration properties to your appsettings.json:

{
  "MockOptions": {
    "ExcludedRequestPaths": ["/api/health", "/openapi", "/metrics", "/redoc", "/swagger"],
    "ResponseMappings": {
      "Namespace.TypeName": "ExampleResponse.json",
      "Namespace.TypeName.Variant": "subfolder/ExampleResponse.Variant.json"
    },
    "UseMock": true
  }
}

💡 Azure Blob Storage supports virtual folders by including / in blob names.

For example, "subfolder/ExampleResponse.Variant.json" will correctly resolve and retrieve the mock from the subfolder virtual directory.

<p align="right">(<a href="#readme-top">back to top</a>)</p>

🔧 BlobStorageOptions Configuration

The following configuration properties are used by the Azure Blob Storage mock provider. These settings are nested under MockOptions:BlobStorageOptions.

🔐 These values should be stored in user secrets or injected securely via environment variables or Key Vault.

<p align="right">(<a href="#readme-top">back to top</a>)</p>

🚀 Usage: AddAzureBlobStorage

Register the middleware in Startup.cs or Program.cs:

services.AddApiMocking(Configuration)
	.AddAzureBlobStorage();

Use the middleware:

app.UseApiMocking();

<p align="right">(<a href="#readme-top">back to top</a>)</p>

🧪 Troubleshooting

Missing Configurations

⚠️ Missing ConnectionString

Error Message

AzureBlobStorageOptions.ConnectionString must not be null or empty.

Cause

The ConnectionString was not provided in MockOptions:BlobStorageOptions, or it wasn't loaded via configuration (e.g. missing from secrets or environment).

Solution

Set the connection string securely via User Secrets, environment variables, or other config providers:

dotnet user-secrets set "MockOptions:BlobStorageOptions:ConnectionString" "<your-connection-string>"

⚠️ Missing ContainerName

Error Message

AzureBlobStorageOptions.ContainerName must not be null or empty.

Cause

The ContainerName was not provided in MockOptions:BlobStorageOptions, or it wasn't loaded via configuration (e.g. missing from secrets or environment).

Solution

Set the container name securely via User Secrets, environment variables, or other config providers:

dotnet user-secrets set "MockOptions:BlobStorageOptions:ContainerName" "<your-container-name>"

Runtime Errors

⚠️ Blob container not found

Error Message

The specified container does not exist.

Cause

The ContainerName is incorrect, or the specified container does not exist in the configured Azure Storage account.

Solution

Double-check the ContainerName setting, verify that the container exists in your Azure Storage account, and the correct permissions are configured for the storage account.

🔐 Ensure the storage account connection string has read permissions to the container. This is typically required if using a shared access key or managed identity.

📘 For additional error handling scenarios, see the Core Troubleshooting Guide.

<p align="right">(<a href="#readme-top">back to top</a>)</p>