jaguar

ジャガー

Jaguarは、高速でシンプルで直感的なように構築されたフルスタックの制作準備完了HTTPサーバーフレームワークです。

はじめる

ルートを書くためのおなじみの方法

Jaguarクラスは、メソッドget 、 put 、 post 、 delete 、および特定のHTTPメソッドのルートハンドラーをすばやく追加するためのoptionsを提供します。

 main () async {
  final server = Jaguar ();  // Serves the API at localhost:8080 by default
  // Add a route handler for 'GET' method at path '/hello'
  server. get ( '/hello' , ( Context ctx) => 'Hello world!' );
  await server. serve ();
}

強力なルートマッチング

パスパラメーターを簡単に定義およびアクセスします

前に付けられたパスセグメント:任意の値と一致させることができ、パス変数としてキャプチャされます。 pathParams Context Objectのメンバーを使用して、パス変数にアクセスできます。

 main ( List < String > args) async {
  final quotes = < String > [
    'But man is not made for defeat. A man can be destroyed but not defeated.' ,
    'When you reach the end of your rope, tie a knot in it and hang on.' ,
    'Learning never exhausts the mind.' ,
  ];

  final server = Jaguar ();
  server. get ( '/api/quote/:index' , (ctx) { // The magic!
    final int index = ctx.pathParams. getInt ( 'index' , 1 );  // The magic!
    return quotes[index + 1 ];
  });
  await server. serve ();
}

• パスには複数のパス変数があります。
• パス変数は、パス内の任意の位置に表示できます。
• パス変数は、正規表現と一致させることができます。
• getInt 、 getDouble 、 getNumおよびgetBoolメソッドを使用して、パス変数を簡単にタイプキャストできます。
• 最終パスセグメントとして *を使用して、次のすべてのセグメントをキャプチャ/一致させます。

クエリパラメーターに簡単にアクセスできます

クエリパラメーターは、 Context ObjectのqueryParamsメンバーを使用してアクセスできます。

 main ( List < String > args) async {
  final quotes = < String > [
    'But man is not made for defeat. A man can be destroyed but not defeated.' ,
    'When you reach the end of your rope, tie a knot in it and hang on.' ,
    'Learning never exhausts the mind.' ,
  ];

  final server = Jaguar ();
  server. get ( '/api/quote' , (ctx) {
    final int index = ctx.queryParams. getInt ( 'index' , 1 ); // The magic!
    return quotes[index + 1 ];
  });
  await server. serve ();
}

getInt 、 getDouble 、 getNum 、およびgetBoolメソッドを使用して、クエリパラメーターを希望のタイプに簡単に型付けすることができます。

フォームにアクセスする1つのライナー

単一の行は、フォームをMap<String, String> Requestオブジェクトに合わせてメソッドbodyAsUrlEncodedFormを使用してフォームを取得します。

 main ( List < String > arguments) async {
  final server = Jaguar (port : 8005 );

  server. postJson ( '/api/add' , (ctx) async {
      final Map < String , String > map = await ctx.req. bodyAsUrlEncodedForm (); // The magic!
      contacts. add ( Contact . create (map));
      return contacts. map ((ct) => ct.toMap). toList ();
    });


  await server. serve ();
}

静的ファイルを提供する1つのライナー

メソッドstaticFiles 、静的ファイルをJaguarサーバーに追加します。最初の引数は、多くのものが一致するリクエストURIを決定し、2番目の引数はターゲットファイルが取得されるディレクトリを決定します。

 main () async {
  final server = Jaguar ();
  server. staticFiles ( '/static/*' , 'static' ); // The magic!
  await server. serve ();
}

JSONのシリアル化はほとんど努力していません

JSONリクエストのデコードはRequestに応じて、組み込みのbodyAsJson 、 bodyAsJsonMap 、またはbodyAsJsonListメソッドのいずれかを使用するよりも簡単ではありません。

 Future < void > main ( List < String > args) async {
  final server = Jaguar ();
  server. postJson ( '/api/book' , ( Context ctx) async {
    // Decode request body as JSON Map
    final Map < String , dynamic > json = await ctx.req. bodyAsJsonMap ();
    Book book = Book . fromMap (json);
    return book; // Automatically encodes Book to JSON
  });

  await server. serve ();
}

すぐにボックスセッションのサポート

 main () async {
  final server = Jaguar ();
  server. get ( '/api/add/:item' , (ctx) async {
    final Session session = await ctx.req.session;
    final String newItem = ctx.pathParams.item;

    final List < String > items = (session[ 'items' ] ?? '' ). split ( ',' );

    // Add item to shopping cart stored on session
    if ( ! items. contains (newItem)) {
      items. add (newItem);
      session[ 'items' ] = items. join ( ',' );
    }

    return Response . redirect ( '/' );
  });
  server. get ( '/api/remove/:item' , (ctx) async {
    final Session session = await ctx.req.session;
    final String newItem = ctx.pathParams.item;

    final List < String > items = (session[ 'items' ] ?? '' ). split ( ',' );

    // Remove item from shopping cart stored on session
    if (items. contains (newItem)) {
      items. remove (newItem);
      session[ 'items' ] = items. join ( ',' );
    }

    return Response . redirect ( '/' );
  });
  await server. serve ();
}