Skip to content

DEVELOPMENT.md

Latest commit

 

History

History
108 lines (68 loc) · 3.14 KB

DEVELOPMENT.md

File metadata and controls

108 lines (68 loc) · 3.14 KB

Development Guide

This guide covers setting up your development environment for the MinIO .NET SDK.

Prerequisites: Installing the .NET SDK

The SDK targets net6.0 through net10.0. Install a recent .NET SDK (8.0 or later recommended).

Windows

Download and run the installer from dotnet.microsoft.com/download, or use winget:

winget install Microsoft.DotNet.SDK.10

macOS

brew install dotnet

Linux (Debian/Ubuntu)

sudo apt-get update && sudo apt-get install -y dotnet-sdk-10.0

For other distributions see the official install docs.

Verify the installation

dotnet --version

IDE Setup

Visual Studio Code

  1. Install the C# Dev Kit extension (includes OmniSharp/Roslyn language server, test explorer, and debugger).
  2. Open the repository root folder — VS Code will detect minio-dotnet2.sln automatically.
  3. When prompted, select the solution file to activate IntelliSense across all projects.

The repository already contains the settings to debug the example projects using VSCode.

JetBrains Rider

  1. Open Rider and choose Open → select minio-dotnet2.sln.
  2. Rider will restore NuGet packages and index the solution automatically.
  3. The built-in test runner (under View → Tool Windows → Unit Tests) discovers xUnit tests without additional configuration.
  4. To run an example project, right-click it in the Solution Explorer and choose Run or Debug.

No plugins are required. Rider ships with first-class .NET support out of the box. Note that JetBrains Rider also provides a much better interface to debug individual or a set of tests.

Example Projects

Both examples connect to a local MinIO server. Start one with Docker before running them:

docker run --rm -p 9000:9000 quay.io/minio/minio:latest server /data

The default credentials used in the examples are minioadmin / minioadmin.

Minio.Examples.Simple

Path: Minio.Examples.Simple/Program.cs

A minimal console application that uses MinioClientBuilder directly (no dependency injection). It demonstrates:

  • Creating a client with static credentials
  • Checking whether a bucket exists and creating it if not

Run it:

dotnet run --project Minio.Examples.Simple

Minio.Examples.Host

Path: Minio.Examples.Host/Program.cs

A console application that uses Microsoft.Extensions.Hosting and the AddMinio DI extension. It demonstrates:

  • Registering the MinIO client in an IHost service container
  • Structured logging via Microsoft.Extensions.Logging
  • Creating a bucket and writing 100 objects in parallel
  • Reading an object back as a stream
  • Listing objects with a prefix and page size
  • Subscribing to real-time bucket notifications via IObservable<T>

Run it:

dotnet run --project Minio.Examples.Host

To target a specific .NET version (the projects multi-target net6.0–net10.0):

dotnet run --project Minio.Examples.Host --framework net8.0