SwiftStack 0.1.20

SwiftStack

SwiftStack is an opinionated and easy way to build REST APIs taking inspiration from elegant model shown in FastAPI in Python.

New in v0.1.x

• Initial alpha release, all APIs subject to change
• Add support for server-sent events

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();

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

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

        app.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.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.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.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();
        app.AuthenticationRoute = AuthenticationRoute;
        app.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.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.

Logo

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