Resumo da Documentação

Bem-vindo

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 … Instalação Você pode instalar o Sisk via NuGet, dotnet CLI ou outras opções. Você pode configurar facilmente seu ambiente Sisk executando este comando … Suporte Nativo AOT .NET Native AOT permite a publicação de aplicativos .NET nativos que são autossuficientes e não requerem o tempo de execução do .NET … Implantando sua aplicação Sisk O processo de implantação de uma aplicação Sisk consiste em publicar seu projeto em produção. Embora o processo seja relativamente simples, … Trabalhando com SSL Trabalhar com SSL durante o desenvolvimento pode ser necessário ao atuar em contextos que exigem segurança, como a maioria dos cenários de … Cadente Cadente é uma implementação experimental gerenciada de listener HTTP/1.1 para o Sisk. Ela serve como substituta do System.Net.HttpListener … Configurando reservas de namespace no Windows Nota Esta configuração é opcional e só é necessária quando você deseja que o Sisk escute em hosts diferentes de “localhost” no … Registros de alterações Todas as alterações feitas no Sisk são registradas no changelog. Você pode ver os changelogs de todas as versões do Sisk aqui. Migrando da … Perguntas Frequentes Perguntas frequentes sobre Sisk. O Sisk é de código aberto? # Totalmente. Todo o código-fonte utilizado pelo Sisk é publicado e atualizado …

Fundamentos

Roteamento O Router é o primeiro passo na construção do servidor. Ele é responsável por armazenar objetos Route, que são pontos de extremidade que … Manipulação de requisições Handlers de requisição, também conhecidos como “middlewares”, são funções que são executadas antes ou depois que uma requisição … Requisições Requisições são estruturas que representam uma mensagem de requisição HTTP. O objeto HttpRequest contém funções úteis para manipular … Respostas Respostas representam objetos que são respostas HTTP a requisições HTTP. Elas são enviadas pelo servidor ao cliente como uma indicação da …

Recursos

Registro de Log Você pode configurar o Sisk para gravar logs de acesso e de erro automaticamente. É possível definir rotação de logs, extensões e … Eventos Enviados pelo Servidor O Sisk oferece suporte ao envio de mensagens através de Server Sent Events nativamente. Você pode criar conexões descartáveis e … Web Sockets O Sisk também oferece suporte a web sockets, permitindo receber e enviar mensagens ao cliente. Esse recurso funciona bem na maioria dos … Sintaxe de descarte O servidor HTTP pode ser usado para ouvir uma solicitação de callback de uma ação, como autenticação OAuth, e pode ser descartado após … Injeção de Dependência É comum dedicar membros e instâncias que duram por toda a vida de uma solicitação, como uma conexão de banco de dados, um usuário … Streaming de Conteúdo O Sisk suporta a leitura e o envio de fluxos de conteúdo para e do cliente. Essa funcionalidade é útil para remover a sobrecarga de memória … Habilitando CORS (Compartilhamento de Recursos entre Origens) no Sisk Sisk possui uma ferramenta que pode ser útil para lidar com Cross-Origin Resource Sharing (CORS) ao expor seu serviço publicamente. Esse … Servidor de Arquivos Sisk fornece o namespace Sisk.Http.FileSystem, que contém ferramentas para servir arquivos estáticos, listagem de diretórios e conversão de …

Extensões

Protocolo de Contexto de Modelo É possível criar aplicações que fornecem contexto a modelos de agente usando grandes modelos de linguagem (LLMs) com o pacote … Extensão JSON-RPC Sisk possui um módulo experimental para uma API JSON-RPC 2.0, que permite criar aplicações ainda mais simples. Esta extensão implementa … Provedores de Serviço Provedores de Serviço são uma forma de portar sua aplicação Sisk para diferentes ambientes com um arquivo de configuração portátil. Esse … Provedor de configuração INI Sisk possui um método para obter configurações de inicialização diferentes de JSON. Na verdade, qualquer pipeline que implemente … Documentação da API A extensão Sisk.Documenting permite gerar documentação de API para sua aplicação Sisk automaticamente. Ela aproveita a estrutura do seu … Autenticação Básica (descontinuada) Cuidado Descontinuado, não use. O pacote Sisk.BasicAuth não é mais mantido e está obsoleto no NuGet, sem pacote substituto. Seu … Proxy SSL (descontinuado) Cuidado Descontinuado, não use. O pacote Sisk.SslProxy não é mais mantido e está obsoleto no NuGet, sem pacote substituto. Ele não compila …

Avançado

Configuração manual (avançada) Use a configuração manual quando precisar montar as peças do servidor por conta própria, como quando um processo deve expor vários hosts, … Ciclo de vida da requisição Abaixo é explicado todo o ciclo de vida de uma requisição através de um exemplo de requisição HTTP. Recebendo a requisição: cada requisição … Resolvedores de Encaminhamento Um Resolvedor de Encaminhamento é um auxiliar que ajuda a decodificar informações que identificam o cliente por meio de uma requisição, … Manipuladores de servidor HTTP Na versão 0.16 do Sisk, introduzimos a classe HttpServerHandler, que tem como objetivo estender o comportamento geral do Sisk e fornecer … Múltiplos hosts de escuta por servidor O Sisk Framework sempre suportou o uso de mais de um host por servidor, ou seja, um único servidor HTTP pode escutar em várias portas e cada … Motores de Servidor HTTP O Sisk Framework é dividido em vários pacotes, onde o principal (Sisk.HttpServer) não inclui um servidor HTTP base - por padrão, o …