SwiftStack 0.2.0

.NET 8.0 This package targets .NET 8.0. The package is compatible with this framework or higher. .NET Standard 2.0 This package targets .NET Standard 2.0. The package is compatible with this framework or higher. 
dotnet add package SwiftStack --version 0.2.0
                    


                    

                
NuGet\Install-Package SwiftStack -Version 0.2.0
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="SwiftStack" Version="0.2.0" />
For projects that support PackageReference, copy this XML node into the project file to reference the package. 
<PackageVersion Include="SwiftStack" Version="0.2.0" />
                    


                            Directory.Packages.props
                        

                    

                
<PackageReference Include="SwiftStack" />
                    


                            Project file
For projects that support Central Package Management (CPM), copy this XML node into the solution Directory.Packages.props file to version the package. 
paket add SwiftStack --version 0.2.0
                    


                    

                
#r "nuget: SwiftStack, 0.2.0"
#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. 
#:package SwiftStack@0.2.0
#:package directive can be used in C# file-based apps starting in .NET 10 preview 4. Copy this into a .cs file before any lines of code to reference the package. 
#addin nuget:?package=SwiftStack&version=0.2.0
                    


                            Install as a Cake Addin
                        

                    

                
#tool nuget:?package=SwiftStack&version=0.2.0
                    


                            Install as a Cake Tool

alt tag

SwiftStack

NuGet Version NuGet

SwiftStack is an opinionated and easy way to build distributed systems, including RESTful and message queue oriented, taking inspiration from elegant model shown in FastAPI in Python.

New in v0.2.x

  • Collapse REST methods into RestApp

Donations

If you would like to financially support my efforts, first of all, thank you! Please refer to DONATIONS.md.

Simple Example

Refer to the Test project and the test.bat batch file to test a simple example of SwiftStack.

using SwiftStack;

class Program
{
    static async Task Main(string[] args)
    {
        SwiftStackApp app = new SwiftStackApp("My test application");

        app.Rest.Route("GET", "/", async (req) => "Hello world");

        app.Rest.Route("POST", "/loopback", async (req) => req.Data);

        app.Rest.Get("/search", async (req) =>
        {
            string query = req.Query["q"];
            if (string.IsNullOrEmpty(query)) query = "no query provided";
            int page = int.TryParse(req.Query["page"] as string, out int p) ? p : 1;

            return new
            {
                Query = query,
                Page = page,
                Message = $"Searching for '{query}' on page {page}"
            };
        });

        app.Rest.Put<User>("/user/{id}", async (req) =>
        {
            string id = req.Parameters["id"];
            User user = req.GetData<User>();
            return new User
            {
                Id = id,
                Email = user.Email,
                Password = user.Password
            };
        });

        app.Rest.Get("/events/{count}", async (req) => // server-sent events
        {
            int count = Convert.ToInt32(req.Parameters["count"].ToString());
            req.Http.Response.ServerSentEvents = true;

            for (int i = 0; i < count; i++)
            {
                await req.Http.Response.SendEvent("Event " + i, false);
                await Task.Delay(500);
            }

            await req.Http.Response.SendEvent(null, true);
            return null;
        });

        await app.Rest.Run();
    }
}

public class User
{
    public string Id { get; set; }
    public string Email { get; set; }
    public string Password { get; set; }
}

Example with Authentication

using SwiftStack;
using SerializationHelper;

class Program
{
    static async Task Main(string[] args)
    {
        Serializer serializer = new Serializer();
        SwiftStackApp app = new SwiftStackApp("My test application");
        app.Rest.AuthenticationRoute = AuthenticationRoute;
        app.Rest.Route("GET", "/authenticated", async (req) => 
        {
            Console.WriteLine("HTTP context metadata: " + Environment.NewLine + serializer.SerializeJson(req.Http.Metadata, true));

            // HTTP context metadata: 
            // {
            //     "Authorized": true,
            //     "Method": "credentials"
            // }

            return "Hello, authenticated user";
        }, true);

        await app.Rest.Run();
    }

    static async Task<AuthResult> AuthenticationRoute(HttpContextBase ctx)
    {
        if (ctx.Request.Authorization != null)
        {
            if (!String.IsNullOrEmpty(ctx.Request.Authorization.Username)
                && !String.IsNullOrEmpty(ctx.Request.Authorization.Password)
                && ctx.Request.Authorization.Username.Equals("user")
                && ctx.Request.Authorization.Password.Equals("password"))
            {
                // pass any object back to your code
                ctx.Metadata = new
                {
                    Authorized = true,
                    Method = "credentials"
                };

                return new AuthResult
                {
                    AuthenticationResult = AuthenticationResultEnum.Success,
                    AuthorizationResult = AuthorizationResultEnum.Permitted
                };
            }
        }

        return new AuthResult
        {
            AuthenticationResult = AuthenticationResultEnum.NotFound,
            AuthorizationResult = AuthorizationResultEnum.Denied
        };
    }
}

Version History

Please refer to CHANGELOG.md for details.

Thanks to pngall.com for making this fantastic logo available.

Product Compatible and additional computed target framework versions.
.NET net5.0 was computed.  net5.0-windows was computed.  net6.0 was computed.  net6.0-android was computed.  net6.0-ios was computed.  net6.0-maccatalyst was computed.  net6.0-macos was computed.  net6.0-tvos was computed.  net6.0-windows was computed.  net7.0 was computed.  net7.0-android was computed.  net7.0-ios was computed.  net7.0-maccatalyst was computed.  net7.0-macos was computed.  net7.0-tvos was computed.  net7.0-windows was computed.  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.  net9.0 was computed.  net9.0-android was computed.  net9.0-browser was computed.  net9.0-ios was computed.  net9.0-maccatalyst was computed.  net9.0-macos was computed.  net9.0-tvos was computed.  net9.0-windows was computed.  net10.0 was computed.  net10.0-android was computed.  net10.0-browser was computed.  net10.0-ios was computed.  net10.0-maccatalyst was computed.  net10.0-macos was computed.  net10.0-tvos was computed.  net10.0-windows was computed. 
.NET Core netcoreapp2.0 was computed.  netcoreapp2.1 was computed.  netcoreapp2.2 was computed.  netcoreapp3.0 was computed.  netcoreapp3.1 was computed. 
.NET Standard netstandard2.0 is compatible.  netstandard2.1 is compatible. 
.NET Framework net461 was computed.  net462 was computed.  net463 was computed.  net47 was computed.  net471 was computed.  net472 was computed.  net48 was computed.  net481 was computed. 
MonoAndroid monoandroid was computed. 
MonoMac monomac was computed. 
MonoTouch monotouch was computed. 
Tizen tizen40 was computed.  tizen60 was computed. 
Xamarin.iOS xamarinios was computed. 
Xamarin.Mac xamarinmac was computed. 
Xamarin.TVOS xamarintvos was computed. 
Xamarin.WatchOS xamarinwatchos was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages

This package is not used by any NuGet packages.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last Updated
0.2.0 70 5 days ago
0.1.20 212 2 months ago
0.1.19 141 3 months ago
0.1.18 100 3 months ago
0.1.16 152 4 months ago
0.1.15 140 4 months ago
0.1.13 142 4 months ago
0.1.12 143 4 months ago
0.1.11 136 4 months ago
0.1.10 140 4 months ago
0.1.9 125 4 months ago
0.1.8 65 4 months ago
0.1.7 67 4 months ago
0.1.5 84 4 months ago
0.1.4 75 4 months ago
0.1.3 133 4 months ago
0.1.2 89 5 months ago
0.1.1 83 5 months ago
0.1.0 90 5 months ago

Initial release