Começando

Bem-vindo à documentação do Sisk!

Sisk é um framework HTTP leve e de código aberto para .NET. Você pode usá-lo para criar um serviço web independente, incorporar um módulo HTTP dentro de uma aplicação existente ou executar um serviço atrás de um proxy reverso com apenas a configuração que você precisa.

Os valores do Sisk incluem transparência de código, modularidade, desempenho e escalabilidade. Ele pode lidar com diferentes estilos de aplicação, incluindo APIs RESTful, serviços JSON‑RPC, WebSockets, Server‑Sent Events e serviço de arquivos estáticos.

Suas principais funcionalidades incluem:

Recurso	Descrição
Routing	Um roteador de caminhos que suporta prefixos, métodos personalizados, variáveis de caminho, conversores de valores e mais.
Request Handlers	Também conhecido como middlewares, fornece uma interface para criar seus próprios manipuladores de requisição que atuam antes ou depois de uma ação.
Compression	Comprima facilmente o conteúdo das respostas com o Sisk.
Web sockets	Fornece rotas que aceitam web‑sockets completos, para leitura e escrita no cliente.
Server-sent events	Fornece o envio de eventos do servidor para clientes que suportam o protocolo SSE.
Logging	Log simplificado. Registre erros, acessos, defina rotação de logs por tamanho, múltiplos fluxos de saída para o mesmo log, e mais.
Multi-host	Tenha um servidor HTTP para múltiplas portas, e cada porta com seu próprio roteador, e cada roteador com sua própria aplicação.
Server handlers	Estenda sua própria implementação do servidor HTTP. Personalize com extensões, melhorias e novos recursos.

Primeiros passos #

Sisk pode ser executado em qualquer ambiente .NET. Neste guia, ensinaremos como criar uma aplicação Sisk usando .NET. Se ainda não o instalou, por favor baixe o SDK aqui.

Neste tutorial, abordaremos como criar uma estrutura de projeto, receber uma requisição, obter um parâmetro de URL e enviar uma resposta. Este guia focará na construção de um servidor simples usando C#. Você também pode usar sua linguagem de programação favorita.

Nota

Você pode estar interessado em um projeto de início rápido. Confira este repositório para mais informações.

Criando um Projeto #

Vamos chamar nosso projeto de “My Sisk Application”. Depois de configurar o .NET, você pode criar seu projeto com o seguinte comando:

Bash

dotnet new console -n my-sisk-application

Em seguida, navegue até o diretório do seu projeto e instale o Sisk usando a ferramenta de utilitário do .NET:

Bash

cd my-sisk-application
dotnet add package Sisk.HttpServer

Você pode encontrar maneiras adicionais de instalar o Sisk em seu projeto aqui.

Agora, vamos criar uma instância do nosso servidor HTTP. Para este exemplo, vamos configurá-lo para escutar na porta 5000.

Construindo o Servidor HTTP #

Sisk permite que você construa sua aplicação passo a passo manualmente, pois ele roteia para o objeto HttpServer. No entanto, isso pode não ser muito conveniente para a maioria dos projetos. Portanto, podemos usar o método builder, que facilita colocar nossa aplicação em funcionamento.

Program.csC#

class Program
{
    static async Task Main(string[] args)
    {
        using var app = HttpServer.CreateBuilder()
            .UseListeningPort("http://localhost:5000/")
            .Build();
        
        app.Router.MapGet("/", request =>
        {
            return new HttpResponse()
            {
                Status = 200,
                Content = new StringContent("Hello, world!")
            };
        });
        
        await app.StartAsync();
    }
}

É importante entender cada componente vital do Sisk. Mais adiante neste documento, você aprenderá mais sobre como o Sisk funciona.

Configuração Manual (avançada) #

Você pode aprender como cada mecanismo do Sisk funciona nesta seção da documentação, que explica o comportamento e as relações entre o HttpServer, Router, ListeningPort e outros componentes.