SurrealDb.MinimalApis.Extensions 0.7.0

SurrealDb.MinimalApis.Extensions

A set of extensions and helpers to use SurrealDB with ASP.NET Core Minimal APIs.

Documentation

View the SDK documentation here.

How to install

dotnet add package SurrealDb.MinimalApis.Extensions
dotnet add package SurrealDb.Net
dotnet add package Microsoft.AspNetCore.OpenApi

Getting started

The MapSurrealEndpoints extension method allows you to map API endpoints for an entity/table.

app
  .MapGroup("/api")
  .MapSurrealEndpoints<WeatherForecast>(
    "/weatherForecast",
    new() { Tags = ["WeatherForecast"], EnableMutations = false }
  )
  .MapSurrealEndpoints<Todo>("/todo", new() { Tags = ["Todo"] });

This method will generate the following API endpoints:

You can choose to disable some of the API endpoints via the options pattern.

Contributing

.NET release versions

The .NET release versions must follow these rules:

• Should target at least the latest LTS (Long-Term Support) version
• Should target at least the latest STS (Standard-Term Support) version

SurrealDb.Net targets .NET versions following the .NET Support Policy by Microsoft. Additionally, SurrealDb.Net targets .NET Standard 2.1 explicitly to continue support of the Mono runtime (Unity, Xamarin, etc...).

Note that the support for .NET standard 2.1 will be maintained until further notice.

Formatting

This project is using CSharpier, an opinionated code formatter.

Command line

You can install it on your machine via dotnet tool.

# Run this command at the root of the project
dotnet tool install csharpier

You can then use it as a cli:

dotnet csharpier .

The list of command-line options is available here: https://csharpier.com/docs/CLI

IDE integration

CSharpier supports multiple code editors, including Visual Studio, Jetbrains Rider, VSCode and Neovim. You will be able to run format on file save after configuring the settings in your IDE.