jaguar

Jaguar

Jaguar es un marco de servidor HTTP de producción completa de producción completa creado para ser rápido, simple e intuitivo.

Empezando

Forma familiar de escribir rutas

Jaguar Class proporciona métodos get , put , post , delete y options para agregar rápidamente controladores de ruta para métodos HTTP específicos.

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

Potente coincidencia de ruta

Definir y acceder fácilmente a los parámetros de la ruta

Los segmentos de ruta prefijados con : pueden coincidir con cualquier valor y también se capturan como variables de ruta. Se pueden acceder a las variables de ruta utilizando el objeto pathParams del objeto Context .

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

• Una ruta puede tener múltiples variables de ruta.
• Una variable de ruta puede aparecer en cualquier posición en la ruta.
• Una variable de ruta puede coincidir con una expresión regular.
• Los métodos getInt , getDouble , getNum y getBool se pueden usar para escribir fácilmente las variables de ruta.
• Usar * como el segmento de ruta final captura/coincide con todos los siguientes segmentos.

Acceder fácilmente a los parámetros de consulta

Se pueden acceder a los parámetros de consulta utilizando el miembro de queryParams del objeto Context .

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

Los métodos getInt , getDouble , getNum y getBool se pueden usar para escribir fácilmente los parámetros de consulta en el tipo deseado.

Un revestimiento para acceder a formularios

Una sola línea es todo lo que se necesita para obtener un formulario como un Map<String, String> usando el método bodyAsUrlEncodedForm en el objeto Request .

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

Un revestimiento para servir archivos estáticos

El método staticFiles agrega archivos estáticos al servidor Jaguar . El primer argumento determina la solicitud URI que se coincide y el segundo argumento determina el directorio desde el cual se obtienen los archivos de destino.

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

JSON Serialización con poco esfuerzo

Las solicitudes de decodificación de JSON no pueden ser más simples que usar uno de los métodos incorporados bodyAsJson , bodyAsJsonMap o bodyAsJsonList en el objeto 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 ();
}

Soporte de sesiones listos para usar

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