2019-04-20 19:45:42 +00:00
|
|
|
# angel_orm_service
|
2019-04-20 19:45:59 +00:00
|
|
|
[![Pub](https://img.shields.io/pub/v/angel_orm_service.svg)](https://pub.dartlang.org/packages/angel_orm_service)
|
2019-04-20 19:45:42 +00:00
|
|
|
[![build status](https://travis-ci.org/angel-dart/orm.svg)](https://travis-ci.org/angel-dart/orm)
|
|
|
|
|
|
|
|
Service implementation that wraps over Angel ORM Query classes.
|
|
|
|
|
2019-04-20 21:34:14 +00:00
|
|
|
## Installation
|
|
|
|
In your `pubspec.yaml`:
|
|
|
|
|
|
|
|
```yaml
|
|
|
|
dependencies:
|
|
|
|
angel_orm_service: ^1.0.0
|
|
|
|
```
|
|
|
|
|
2019-04-20 19:45:42 +00:00
|
|
|
## Usage
|
|
|
|
Brief snippet (check `example/main.dart` for setup, etc.):
|
|
|
|
|
|
|
|
```dart
|
|
|
|
// Create an ORM-backed service.
|
|
|
|
var todoService = OrmService<int, Todo, TodoQuery>(
|
|
|
|
executor, () => TodoQuery(),
|
|
|
|
readData: (req, res) => todoSerializer.decode(req.bodyAsMap));
|
|
|
|
|
|
|
|
// Because we provided `readData`, the todoService can face the Web.
|
|
|
|
// **IMPORTANT: Providing the type arguments is an ABSOLUTE MUST, if your
|
|
|
|
// model has `int` ID's (this is the case when using `angel_orm_generator` and `Model`).
|
|
|
|
// **
|
|
|
|
app.use<int, Todo, OrmService<int, Todo, TodoQuery>>(
|
|
|
|
'/api/todos', todoService);
|
|
|
|
```
|