Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/jaguar-dart/jaguar
Jaguar, a server framework built for speed, simplicity and extensible. ORM, Session, Authentication & Authorization, OAuth
https://github.com/jaguar-dart/jaguar
authentication authorization dart http jaguar orm rest rest-api restful routing session web webserver websocket
Last synced: about 2 hours ago
JSON representation
Jaguar, a server framework built for speed, simplicity and extensible. ORM, Session, Authentication & Authorization, OAuth
- Host: GitHub
- URL: https://github.com/jaguar-dart/jaguar
- Owner: Jaguar-dart
- Created: 2016-09-22T11:01:50.000Z (about 8 years ago)
- Default Branch: master
- Last Pushed: 2024-09-08T23:00:41.000Z (2 months ago)
- Last Synced: 2024-10-30T02:59:42.767Z (16 days ago)
- Topics: authentication, authorization, dart, http, jaguar, orm, rest, rest-api, restful, routing, session, web, webserver, websocket
- Language: Dart
- Homepage: http://jaguar-dart.github.io
- Size: 2.79 MB
- Stars: 463
- Watchers: 17
- Forks: 35
- Open Issues: 24
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
[](https://pub.dartlang.org/packages/jaguar)
[](https://travis-ci.org/Jaguar-dart/jaguar)
[](https://gitter.im/jaguar_dart/jaguar)
# Jaguar
Jaguar is a full-stack production ready HTTP server framework built to be fast, simple and intuitive.
# Getting started
## Familiar way to write routes
[`Jaguar`][Doc::Jaguar] class provides methods [`get`][Doc::Jaguar::get], [`put`][Doc::Jaguar::put], [`post`][Doc::Jaguar::post],
[`delete`][Doc::Jaguar::delete] and [`options`][Doc::Jaguar::options] to quickly add route handlers for specific HTTP methods.
```dart
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();
}
```
## Powerful route matching
### Easily define and access Path parameters
Path segments prefixed with `:` can match any value and are also captured as path variables. Path variables can be accessed
using `pathParams` member of `Context` object.
```dart
main(List args) async {
final quotes = [
'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();
}
```
+ A path can have multiple path variables.
+ A path variable can appear at any position in the path.
+ A path variable can be matched against a Regular expression.
+ `getInt`, `getDouble`, `getNum` and `getBool` methods can be used to easily typecast path variables.
+ Using * as the final path segment captures/matches all following segments.
## Easily access Query parameters
Query parameters can be accessed using `queryParams` member of `Context` object.
```dart
main(List args) async {
final quotes = [
'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` and `getBool` methods can be used to easily typecast query parameters into desired type.
## One liner to access Forms
A single line is all it takes to obtain a form as a `Map` using method [`bodyAsUrlEncodedForm`][Doc::Request::bodyAsUrlEncodedForm]
on [`Request`][Doc::Request] object.
```dart
main(List arguments) async {
final server = Jaguar(port: 8005);
server.postJson('/api/add', (ctx) async {
final Map map = await ctx.req.bodyAsUrlEncodedForm(); // The magic!
contacts.add(Contact.create(map));
return contacts.map((ct) => ct.toMap).toList();
});
await server.serve();
}
```
## One liner to serve static files
The method [`staticFiles`][Doc::Jaguar::staticFiles] adds static files to `Jaguar` server. The first argument determines
the request Uri that much be matched and the second argument determines the directory from which the target files are fetched.
```dart
main() async {
final server = Jaguar();
server.staticFiles('/static/*', 'static'); // The magic!
await server.serve();
}
```
## JSON serialization with little effort
Decoding JSON requests can't be simpler than using one of the built-in [`bodyAsJson`][Doc::Request::bodyAsJson],
[`bodyAsJsonMap`][Doc::Request::bodyAsJsonMap] or [`bodyAsJsonList`][Doc::Request::bodyAsJsonList] methods on
[`Request`][Doc::Request] object.
```dart
Future main(List args) async {
final server = Jaguar();
server.postJson('/api/book', (Context ctx) async {
// Decode request body as JSON Map
final Map 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
```dart
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 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 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();
}
```
[Doc::Jaguar]: https://www.dartdocs.org/documentation/jaguar/latest/jaguar/Jaguar-class.html
[Doc::Jaguar::get]: https://www.dartdocs.org/documentation/jaguar/latest/jaguar/Muxable/get.html
[Doc::Jaguar::delete]: https://www.dartdocs.org/documentation/jaguar/latest/jaguar/Muxable/delete.html
[Doc::Jaguar::post]: https://www.dartdocs.org/documentation/jaguar/latest/jaguar/Muxable/post.html
[Doc::Jaguar::put]: https://www.dartdocs.org/documentation/jaguar/latest/jaguar/Muxable/put.html
[Doc::Jaguar::options]: https://www.dartdocs.org/documentation/jaguar/latest/jaguar/Muxable/options.html
[Doc::Jaguar::staticFiles]: https://www.dartdocs.org/documentation/jaguar/latest/jaguar/Muxable/staticFiles.html
[Doc::Request]: https://www.dartdocs.org/documentation/jaguar/latest/jaguar/Request-class.html
[Doc::Request::bodyAsJson]: https://www.dartdocs.org/documentation/jaguar/latest/jaguar/Request/bodyAsJson.html
[Doc::Request::bodyAsJsonMap]: https://www.dartdocs.org/documentation/jaguar/latest/jaguar/Request/bodyAsJsonMap.html
[Doc::Request::bodyAsJsonList]: https://www.dartdocs.org/documentation/jaguar/latest/jaguar/Request/bodyAsJsonList.html
[Doc::Request::bodyAsUrlEncodedForm]: https://www.dartdocs.org/documentation/jaguar/latest/jaguar/Request/bodyAsUrlEncodedForm.html