# Construir um recurso REST completo com ações

> Declare as ações query, read, insert, update, patch e remove sobre a base de dados NoSQL, com validação, um 404 para registos em falta e rotas que associam cada método HTTP.

Framework: total5
Product: Total.js 5 (total5@0.0.19)
Language: pt
Content-SHA256: 31657156ac82d5c9ee6f7d49a436870225aec509eae34bb61bedff9ce1a0e928
Snapshot: c0700e321579725c5cf4f5ace1ad7d2866d1b4f93c24a63c0b41b6b7998e976c
Sources: total5-installed@total5@0.0.19
Review: not-recorded

Um recurso REST são seis operações: listar (`query`), `read`, `insert`, `update` (substituir), `patch` (alterar alguns campos) e `remove`. No Total.js cada uma é uma ação com a sua própria validação, pelo que a tabela de rotas fica um simples mapa de URL para ação. `params` valida o id do URL, `query` os filtros da lista, `input` o corpo. Dentro de uma ação, `$.params`, `$.query` e o corpo validado (segundo argumento de `action`) já são valores limpos.

Indique que um registo não existe com `$.invalid(404)`: responde com o código de estado e um erro JSON, da mesma forma em todas as ações. `$.success()` responde `{ "success": true }` e `$.callback(value)` responde com um valor, que além disso é filtrado pelo `output` da ação. `UID()` cria o id de um novo registo.

**`patch` precisa de `partial: true`.** Sem ele, um campo que não foi enviado é na mesma preenchido com o valor por omissão do seu tipo (`''` para uma `String`), e `update()` sobrescreveria o valor guardado com esse texto vazio. Com `partial: true` só chegam à ação os campos presentes no pedido.

```js actions/products.js
NEWACTION('Products/query', {
	name: 'List products',
	query: 'page:Number, search:String',
	output: 'items:[id:UID, name:String, price:Number], page:Number',
	action: function($) {
		var page = $.query.page || 1;
		var builder = NOSQL('products').find().sort('name').take(10).skip((page - 1) * 10);
		if ($.query.search)
			builder.search('name', $.query.search);
		builder.callback((err, items) => $.callback({ items: items, page: page }));
	}
});

NEWACTION('Products/read', {
	name: 'Read a product',
	params: '*id:UID',
	output: 'id:UID, name:String, price:Number',
	action: function($) {
		NOSQL('products').read().where('id', $.params.id).callback(function(err, item) {
			if (item)
				$.callback(item);
			else
				$.invalid(404);
		});
	}
});

NEWACTION('Products/insert', {
	name: 'Create a product',
	input: '*name:String, *price:Number',
	action: function($, model) {
		model.id = UID();
		NOSQL('products').insert(model).callback(() => $.callback({ id: model.id }));
	}
});

NEWACTION('Products/update', {
	name: 'Replace a product',
	params: '*id:UID',
	input: '*name:String, *price:Number',
	action: function($, model) {
		NOSQL('products').update(model).where('id', $.params.id).callback(function(err, count) {
			if (count)
				$.success();
			else
				$.invalid(404);
		});
	}
});

NEWACTION('Products/patch', {
	name: 'Change some fields of a product',
	partial: true,
	params: '*id:UID',
	input: 'name:String, price:Number',
	action: function($, model) {
		NOSQL('products').update(model).where('id', $.params.id).callback(function(err, count) {
			if (count)
				$.success();
			else
				$.invalid(404);
		});
	}
});

NEWACTION('Products/remove', {
	name: 'Remove a product',
	params: '*id:UID',
	action: function($) {
		NOSQL('products').remove().where('id', $.params.id).callback(function(err, count) {
			if (count)
				$.success();
			else
				$.invalid(404);
		});
	}
});
```

```js controllers/products.js
exports.install = function() {
	ROUTE('GET    /products/            --> *Products/query');
	ROUTE('GET    /products/{id}/       --> *Products/read');
	ROUTE('POST   /products/            --> *Products/insert');
	ROUTE('PUT    /products/{id}/       --> *Products/update');
	ROUTE('PATCH  /products/{id}/       --> *Products/patch');
	ROUTE('DELETE /products/{id}/       --> *Products/remove');
};
```