# Bygg en komplett REST-resurs med actions

> Deklarera actions för query, read, insert, update, patch och remove över NoSQL-databasen, med validering, ett 404 för saknade poster och rutter som kopplar varje HTTP-metod.

Framework: total5
Product: Total.js 5 (total5@0.0.19)
Language: sv
Content-SHA256: 69ded041922432cccebcac52424b07bbd7c2af697c0cc0c0923fec6605133962
Snapshot: c0700e321579725c5cf4f5ace1ad7d2866d1b4f93c24a63c0b41b6b7998e976c
Sources: total5-installed@total5@0.0.19
Review: not-recorded

En REST-resurs består av sex operationer: lista (`query`), `read`, `insert`, `update` (ersätta), `patch` (ändra några fält) och `remove`. I Total.js är var och en en action med egen validering, så ruttabellen förblir en enkel koppling från URL till action. `params` validerar id:t i URL:en, `query` listans filter och `input` bodyn. Inuti en action är `$.params`, `$.query` och den validerade bodyn (andra argumentet till `action`) redan rena värden.

Rapportera en saknad post med `$.invalid(404)`: den svarar med statuskoden och ett JSON-fel, på samma sätt för varje action. `$.success()` svarar med `{ "success": true }` och `$.callback(value)` svarar med ett värde som dessutom filtreras av actionens `output`. `UID()` skapar id:t för en ny post.

**`patch` behöver `partial: true`.** Utan det fylls ett fält som inte skickats ändå med standardvärdet för sin typ (`''` för en `String`), och `update()` skulle skriva över det sparade värdet med den tomma texten. Med `partial: true` når bara de fält som finns i förfrågan fram till actionen.

```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');
};
```