jaguar

Jaguar

A Jaguar é uma estrutura de servidor HTTP pronta para a produção completa, criada para ser rápida, simples e intuitiva.

Começando

Maneira familiar de escrever rotas

A classe Jaguar fornece métodos, get , put post delete e options para adicionar rapidamente manipuladores de rotas 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 ();
}

Rota poderosa correspondente

Definir e acessar facilmente parâmetros do caminho

Os segmentos de caminho prefixados : podem corresponder a qualquer valor e também são capturados como variáveis ​​de caminho. As variáveis ​​do caminho podem ser acessadas usando o membro pathParams do 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 ();
}

• Um caminho pode ter várias variáveis ​​de caminho.
• Uma variável de caminho pode aparecer em qualquer posição no caminho.
• Uma variável de caminho pode ser comparada com uma expressão regular.
• Os métodos getInt , getDouble , getNum e getBool podem ser usados ​​para facilmente digitar variáveis ​​de caminho.
• Usando * como o segmento de caminho final captura/corresponde a todos os seguintes segmentos.

Acesse os parâmetros de consulta facilmente

Os parâmetros de consulta podem ser acessados ​​usando o membro do contexto do Context 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 ();
}

Os métodos getInt , getDouble , getNum e getBool podem ser usados ​​para digitar facilmente parâmetros de consulta no tipo desejado.

Um revestimento para acessar formulários

Uma única linha é o suficiente para obter um formulário como um Map<String, String> usando o método bodyAsUrlEncodedForm no 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 ();
}

Um revestimento para servir arquivos estáticos

O método staticFiles adiciona arquivos estáticos ao servidor Jaguar . O primeiro argumento determina a solicitação URI que muito corresponde e o segundo argumento determina o diretório a partir do qual os arquivos de destino são buscados.

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

Serialização do JSON com pouco esforço

A decodificação de solicitações JSON não pode ser mais simples do que usar um dos métodos embutidos bodyAsJson , bodyAsJsonMap ou bodyAsJsonList , mediante 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 ();
}

Suporte de sessões prontas para uso

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