# Rota de Sintáxia de Total.js 5

> Declarar rotas Total.js com métodos, parâmetros de URLs, mapas selvagens, bandeiras, autenticação, intermediário e ações.

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

`ROUTE(definition, handler)` declara uma rota. A definição é um texto com estas partes, por esta ordem:

`[+|-]METHOD /url/{param}/ [@flag ...] [#middleware ...] [<limit] [--> *Action ...]`

| Parte | Significado |
|---|---|
| `METHOD` | `GET`, `POST`, `PUT`, `PATCH`, `DELETE`, ou `SOCKET` para um WebSocket e `FILE` para URLs com extensão: um URL como `/a.txt` nunca é apanhado por uma rota `GET`. |
| `+` ou `-` antes do método | `+` aceita apenas os pedidos que `AUTH()` aprovou, `-` apenas os anónimos; qualquer outro pedido recebe um 401. Sem prefixo a rota é aberta. |
| `/url/` | O caminho. Escreva a barra final: as rotas são comparadas com ela. |
| `{name}` | Um segmento do caminho que se lê em `$.params.name`. |
| `*` como último segmento | Corresponde a qualquer caminho abaixo. Uma rota sem `*` é mais específica e ganha. |
| `@flag` | Uma condição para o pedido: `@json`, `@xml`, `@xhr`, `@upload`, `@debug`, `@release`, `@mobile`, `@robot`, `@referer` (ou `@referrer`). |
| `#name` | Um middleware registado com `MIDDLEWARE(name, fn)`. |
| `<limit` | `<10kb` limita o tamanho do corpo, `<30s` o tempo do pedido. |
| `--> *Action` | Executa uma ou mais ações com a entrada do pedido e responde com o resultado. |
| `#404`, `#401`... | Uma rota cuja definição é apenas `#` e um código de estado substitui a página de erro. |

Um pedido é tratado pela primeira rota que corresponde. Um pedido que não cumpre as flags de uma rota segue para a próxima e termina com um 404 quando nenhuma corresponde; um pedido que não cumpre `+` ou `-` recebe um 401. **Uma rota sem flags no mesmo URL ganha sempre a uma rota com flags**, por isso nunca ponha as duas num URL.

```js definitions/auth.js
AUTH(function($) {
	if ($.headers['x-token'] === 'secret')
		$.success({ id: '1' });
	else
		$.invalid();
});

MIDDLEWARE('stamp', function($, next) {
	$.response.headers['x-stamp'] = 'yes';
	next();
});

NEWACTION('Echo/one', { name: 'one', input: '*text:String', action: ($, model) => $.callback({ one: model.text }) });
NEWACTION('Echo/two', { name: 'two', action: ($, model) => $.callback({ two: true }) });
```

```js controllers/syntax.js
exports.install = function() {
	ROUTE('GET /plain/', plain);
	ROUTE('GET /users/{id}/', user);
	ROUTE('GET /files/*', files);
	ROUTE('POST /json/ @json', json);
	ROUTE('+GET /private/', plain);
	ROUTE('-GET /guest/', plain);
	ROUTE('GET /stamped/ #stamp', plain);
	ROUTE('POST /echo/ @json --> *Echo/one');
	ROUTE('FILE /robots-example.txt', file);
	ROUTE('#404', missing);
};

function plain($) {
	$.json({ ok: true });
}

function user($) {
	$.json({ id: $.params.id });
}

function files($) {
	$.json({ url: $.url });
}

function json($) {
	$.json({ body: $.body });
}

function file($) {
	$.plain('from a FILE route');
}

function missing($) {
	$.response.status = 404;
	$.plain('custom 404');
}
```