jaguar

Jaguar

Jaguar ist ein Full-Stack-Produktion, das HTTP Server-Framework für schnell, einfach und intuitiv erstellt hat.

Erste Schritte

Vertraute Art, Routen zu schreiben

Jaguar -Klasse bietet Methoden, um Methoden get , put , post , delete und options schnell hinzuzufügen, um Routenhandler für bestimmte HTTP -Methoden hinzuzufügen.

 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 ();
}

Kraftvoller Routenpassend

Die Parameter auf Pfad und Zugriff auf einfach definieren und zugreifen

Pfadsegmente, die vorangestellt sind : können mit jedem Wert übereinstimmen und werden auch als Pfadvariablen erfasst. Auf Path -Variablen können mit pathParams -Mitglied des Context zugegriffen werden.

 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 ();
}

• Ein Pfad kann mehrere Pfadvariablen haben.
• Eine Pfadvariable kann an jeder Position im Pfad erscheinen.
• Eine Pfadvariable kann mit einem regulären Ausdruck abgestimmt werden.
• getInt , getDouble , getNum und getBool -Methoden können verwendet werden, um leicht Pfadvariablen zu typern.
• Verwenden von * als endgültiges Pfadsegment erfasst/entspricht allen folgenden Segmenten.

Zugriff auf Abfrageparameter einfach zugreifen

Abfrageparameter können mit queryParams -Mitglied des Context zugegriffen werden.

 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 und getBool -Methoden können verwendet werden, um die Abfrageparameter in den gewünschten Typ problemlos zu typern.

Ein Liner zum Zugriff auf Formulare

Eine einzelne Zeile ist alles, um ein Formular als Map<String, String> Verwenden von bodyAsUrlEncodedForm im Request zu erhalten.

 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 ();
}

Ein Liner zum Servieren statischer Dateien

Die Methode staticFiles fügt Jaguar Server statische Dateien hinzu. Das erste Argument bestimmt, dass die Anfrage -URI so viel übereinstimmt, und das zweite Argument bestimmt das Verzeichnis, aus dem die Zieldateien abgerufen werden.

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

JSON -Serialisierung mit wenig Anstrengung

Decodieren von JSON-Anfragen können nicht einfacher sein als die Verwendung eines der integrierten bodyAsJson , bodyAsJsonMap oder bodyAsJsonList Methoden in Request .

 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 ();
}

Out-of-the-Box-Sessions Support

 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 ();
}