shelf_router_generator

Visão geral do pacote

Orientação gerada a partir de informações públicas. Apenas para referência.

ShelfRouterGenerator é um gerador de código em tempo de compilação para o framework web Shelf que cria roteadores de solicitações a partir de anotações de origem. Ele permite que os desenvolvedores definam rotas usando anotações simples e legíveis no código Dart, que são processadas durante a fase de compilação para gerar lógica de roteamento eficiente. Essa abordagem reduz o código repetitivo e melhora a segurança de tipo ao capturar erros de roteamento em tempo de compilação. O pacote se integra perfeitamente ao sistema `package:build` e suporta todas as principais plataformas onde o Dart é executado.

Casos de uso

Definindo APIs REST com manipuladores de rota anotados
Gerando mapeamentos de rota seguros por tipo
Automatizando o boilerplate do roteador em servidores baseados em prateleira
Habilitar a validação de configurações de rota em tempo de compilação
Simplificando estruturas de roteamento complexas em serviços da web

Principais recursos

Definição de rota baseada em anotações
Geração de código em tempo de compilação
roteamento seguro por tipo
Integração com o pacote: build
Suporte para desenvolvimento de servidor independente de plataforma

Indicado para

Desenvolvedores usando Shelf para serviços de backend
Equipes priorizando segurança em tempo de compilação
Projetos que exigem mínimo boilerplate de roteamento
Desenvolvedores Dart direcionados para múltiplas plataformas
Aplicações com alto uso de API e roteamento estruturado

Considerações

Requer build_runner para geração de código
Flexibilidade de tempo de execução limitada em comparação com o roteamento dinâmico
Necessita de entendimento dos fluxos de trabalho do sistema de compilação
Não adequado para configuração de rota em tempo de execução
Pode aumentar levemente os tempos de compilação

Snapshot do README original do repositório-fonte vinculado. Consulte o repositório para o conteúdo mais recente.

About Shelf

Shelf makes it easy to create and compose web servers and parts of web servers. How?

Expose a small set of simple types.
Map server logic into a simple function: a single argument for the request, the response is the return value.
Trivially mix and match synchronous and asynchronous processing.
Flexibility to return a simple string or a byte stream with the same model.

It was inspired by Connect for NodeJS and Rack for Ruby.

See the package:shelf readme for more information.

Packages

Package	Description	Version
shelf	A model for web server middleware that encourages composition and easy reuse.
shelf_packages_handler	A shelf handler for serving a `packages/` directory.
shelf_proxy	A shelf handler for proxying HTTP requests to another server.
shelf_router	A convenient request router for the shelf web-framework, with support for URL-parameters, nested routers and routers generated from source annotations.
shelf_router_generator	A package:build-compatible builder for generating request routers for the shelf web-framework based on source annotations.
shelf_static	Static file server support for the shelf package and ecosystem.
shelf_test_handler	A Shelf handler that makes it easy to test HTTP interactions.
shelf_web_socket	A shelf handler that wires up a listener for every connection.
_shelf_compliance	HTTP/1.1 compliance and hardening tests.	(not published)