ServerlessWorkflow.Sdk 1.0.0-alpha1

This is a prerelease version of ServerlessWorkflow.Sdk.
dotnet add package ServerlessWorkflow.Sdk --version 1.0.0-alpha1
NuGet\Install-Package ServerlessWorkflow.Sdk -Version 1.0.0-alpha1
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.
<PackageReference Include="ServerlessWorkflow.Sdk" Version="1.0.0-alpha1" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add ServerlessWorkflow.Sdk --version 1.0.0-alpha1
#r "nuget: ServerlessWorkflow.Sdk, 1.0.0-alpha1"
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.
// Install ServerlessWorkflow.Sdk as a Cake Addin
#addin nuget:?package=ServerlessWorkflow.Sdk&version=1.0.0-alpha1&prerelease

// Install ServerlessWorkflow.Sdk as a Cake Tool
#tool nuget:?package=ServerlessWorkflow.Sdk&version=1.0.0-alpha1&prerelease

Serverless Workflow .NET SDK

The official .NET SDK for the Serverless Workflow DSL.

The SDK is composed of three Nuget packages:

  • Core, which contains the models of the Serverless Workflow DSL
  • Builders, which contains service used to build workflow definitions programmatically
  • IO, which contains the services used to read and write workflow definitions

Installation

Core:

dotnet add package ServerlessWorkflow.Sdk

Builders:

dotnet add package ServerlessWorkflow.Sdk.Builders

IO:

dotnet add package ServerlessWorkflow.Sdk.IO

Example usage

Building a workflow definition programmatically:

var definition = new WorkflowDefinitionBuilder()
    .WithName("fake-workflow")
    .WithVersion("0.1.0:fake")
    .Do("todo-1", task => task
        .Call("http")
        .With("method", "get")
        .With("uri", "https://fake-api.com"))
    .Build();

Reading and writing a workflow definition:

using var inputStream = File.OpenRead("workflow.yaml");
var reader = WorkflowDefinitionReader.Create();
var workflow = await reader.ReadAsync(inputStream);

using var outputStream = File.Create("workflow.yaml");
var writer = WorkflowDefinitionWriter.Create();
await writer.WriteAsync(workflow, stream, WorkflowDefinitionFormat.Yaml);
Product Compatible and additional computed target framework versions.
.NET net8.0 is compatible.  net8.0-android was computed.  net8.0-browser was computed.  net8.0-ios was computed.  net8.0-maccatalyst was computed.  net8.0-macos was computed.  net8.0-tvos was computed.  net8.0-windows was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages (3)

Showing the top 3 NuGet packages that depend on ServerlessWorkflow.Sdk:

Package Downloads
Synapse.Integration

This package contains everything you need to integrate Synapse WFMS and its APIs

ServerlessWorkflow.Sdk.IO

Contains services used to read and write ServerlessWorkflow workflow definitions

ServerlessWorkflow.Sdk.Builders

Contains services used to build ServerlessWorkflow workflow definitions programatically

GitHub repositories (1)

Showing the top 1 popular GitHub repositories that depend on ServerlessWorkflow.Sdk:

Repository Stars
serverlessworkflow/synapse
Serverless Workflow Management System (WFMS)
Version Downloads Last updated
1.0.0-alpha1 154 5/22/2024
0.8.8 189 1/4/2024
0.8.7 778 6/29/2023
0.8.6 341 11/30/2022
0.8.5 321 11/18/2022
0.8.4 13,462 11/4/2022
0.8.3 7,204 10/26/2022
0.8.2 374 9/30/2022
0.8.1.16 4,183 9/28/2022
0.8.1.15 1,520 9/22/2022
0.8.1.14 3,491 9/9/2022
0.8.1.13 390 9/7/2022
0.8.1.12 378 9/7/2022
0.8.1.11 5,745 8/30/2022
0.8.1.10 2,537 8/23/2022
0.8.1.9 420 8/23/2022
0.8.1.8 3,655 8/11/2022
0.8.1.7 1,490 8/9/2022
0.8.1.6 1,653 5/20/2022
0.8.1.5 409 5/20/2022
0.8.1.4 450 5/18/2022
0.8.1.3 412 5/17/2022
0.8.1.2 430 5/17/2022
0.8.1.1 388 5/17/2022
0.8.1 394 5/16/2022
0.8.0.22 402 5/16/2022
0.8.0.21 496 5/10/2022
0.8.0.20 627 4/14/2022
0.8.0.19 565 4/14/2022
0.8.0.18 416 4/14/2022
0.8.0.17 443 4/13/2022
0.8.0.16 412 4/13/2022
0.8.0.15 554 3/7/2022
0.8.0.14 397 3/7/2022
0.8.0.13 440 3/3/2022
0.8.0.12 412 3/2/2022
0.8.0.11 424 2/25/2022
0.8.0.10 432 2/24/2022
0.8.0.9 439 2/24/2022
0.8.0.8 405 2/23/2022
0.8.0.7 399 2/23/2022
0.8.0.6 414 2/22/2022
0.8.0.5 395 2/21/2022
0.8.0.4 405 2/21/2022
0.8.0.3 419 2/18/2022
0.8.0.2 411 2/15/2022
0.8.0.1 413 2/14/2022
0.8.0 433 2/14/2022
0.7.4.4 366 7/2/2021
0.7.4.3 343 7/2/2021
0.7.4.2 293 7/2/2021
0.7.4.1 275 7/1/2021
0.7.4 317 7/1/2021
0.7.3 291 6/16/2021
0.7.2 335 6/8/2021
0.7.1 335 6/3/2021
0.7.0 285 6/2/2021
0.6.3 341 5/27/2021
0.6.2 316 5/27/2021
0.6.1 774 4/19/2021
0.6.0 354 4/3/2021