jaguar

Ягуар

Jaguar-это работа на сфере производства с полным стеком HTTP Framework, созданная для быстрой, простой и интуитивной.

Начиная

Знакомый способ писать маршруты

Jaguar Class предоставляет методы get , put , post , delete и options для быстрого добавления обработчиков маршрута для конкретных методов HTTP.

 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 .

 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 могут быть использованы для легковых переменных пути типа.
• Использование * в качестве окончательного сегмента пути захватывает/совпадает с следующими сегментами.

Легкий доступ к параметрам запроса

Доступ к параметрам запроса можно получить с помощью члена queryParams 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' , (ctx) {
    final int index = ctx.queryParams. getInt ( 'index' , 1 ); // The magic!
    return quotes[index + 1 ];
  });
  await server. serve ();
}

Методы getInt , getDouble , getNum и getBool могут быть использованы для легковых типовых параметров запроса в желаемый тип.

Один лайнер для доступа к формам

Одна строка - это все, что требуется для получения формы в качестве Map<String, String> используя метод bodyAsUrlEncodedForm в объекте 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 ();
}

Один лайнер для обслуживания статических файлов

Метод staticFiles добавляет статические файлы на сервер Jaguar . Первый аргумент определяет запрос URI, который будет совпадает, а второй аргумент определяет каталог, из которого избираются целевые файлы.

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

Сериализация JSON с небольшим усилием

Декодирование запросов JSON не может быть проще, чем использование одного из встроенных методов bodyAsJson , bodyAsJsonMap или bodyAsJsonList на объекте 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 ();
}

Сессионные сессии поддержка

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