パッケージ詳細v1.1.5

shelf_router_generator

ソースアノテーションに基づいて、shelf Webフレームワーク用のリクエストルーターを生成するための、package:build互換のビルダー。

AndroidiOSmacOSWindowsLinux

pub.dev API ドキュメントソースコード

30日間ダウンロード: 2.3万
いいね数: 71
Pub ポイント: 140

パッケージをインストール

flutter pub add shelf_router_generator

パッケージ概要

公開情報に基づく選定ガイドです。参考としてご利用ください。

ShelfRouterGenerator は、Shelf Web フレームワーク用のビルド時コードジェネレータであり、ソースアノテーションからリクエストルーターを生成します。開発者は Dart コード内でシンプルで読みやすいアノテーションを使用してルートを定義でき、これらはビルドフェーズで処理され、効率的なルーティングロジックが生成されます。このアプローチにより、ボイラープレートが削減され、コンパイル時にルーティングエラーを検出することで型安全が向上します。このパッケージは `package:build` システムとシームレスに統合されており、Dart が実行されるすべての主要プラットフォームをサポートしています。

用途

注釈付きルートハンドラでREST APIを定義する
型安全なルートマッピングの生成
シェルフベースのサーバーにおけるルーターのボイラープレートの自動化
ルート構成のコンパイル時検証を有効化する
Webサービスにおける複雑なルーティング構造の簡素化

主な機能

アノテーションベースのルート定義
ビルド時コード生成
型安全なルーティング
パッケージ: build との統合
プラットフォームに依存しないサーバー開発のサポート

適している対象

バックエンドサービスにShelfを使用する開発者
コンパイル時セキュリティを最優先とするチーム
最小限のルーティングボイラープレートを必要とするプロジェクト
複数のプラットフォームをターゲットにするDart開発者
構造化ルーティングを備えたAPI主体のアプリケーション

注意事項

コード生成には build_runner が必要です
動的ルーティングと比較して実行時における柔軟性が制限される
ビルドシステムのワークフローを理解する必要がある
実行時ルート構成には適していません
ビルド時間をわずかに延長する可能性があります

元の README

関連するソースリポジトリの README 原文のスナップショットです。最新の内容はリポジトリをご覧ください。

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)