# Пътеводител на Total.js 5

> Декларирайте маршрутите на Total.js с методи, URL параметри, дивни карти, знаци, автентичност, посреднически софтуер и действия.

Framework: total5
Product: Total.js 5 (total5@0.0.19)
Language: bg
Content-SHA256: 2fa1c631158f03d23162f0f02311cdb9fb9583c18fc88f5c78cb19d0dc11eb1e
Snapshot: c0700e321579725c5cf4f5ace1ad7d2866d1b4f93c24a63c0b41b6b7998e976c
Sources: total5-installed@total5@0.0.19
Review: not-recorded

`ROUTE(definition, handler)` декларира маршрут. Дефиницията е един текст с тези части, в този ред:

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

| Част | Значение |
|---|---|
| `METHOD` | `GET`, `POST`, `PUT`, `PATCH`, `DELETE`, или `SOCKET` за WebSocket и `FILE` за URL адреси с разширение: URL като `/a.txt` никога не се хваща от маршрут `GET`. |
| `+` или `-` преди метода | `+` приема само заявките, одобрени от `AUTH()`, `-` само анонимните; всяка друга заявка получава 401. Без префикс маршрутът е отворен. |
| `/url/` | Пътят. Напишете завършващата наклонена черта: маршрутите се сравняват с нея. |
| `{name}` | Сегмент от пътя, който се чете от `$.params.name`. |
| `*` като последен сегмент | Съвпада с всеки път под него. Маршрут без `*` е по-конкретен и печели. |
| `@flag` | Условие за заявката: `@json`, `@xml`, `@xhr`, `@upload`, `@debug`, `@release`, `@mobile`, `@robot`, `@referer` (или `@referrer`). |
| `#name` | Middleware, регистриран с `MIDDLEWARE(name, fn)`. |
| `<limit` | `<10kb` ограничава размера на тялото, `<30s` времето на заявката. |
| `--> *Action` | Изпълнява едно или повече действия с входа на заявката и отговаря с резултата. |
| `#404`, `#401`... | Маршрут, чиято дефиниция е само `#` и код на състоянието, замества страницата за грешка. |

Заявката се обработва от първия съвпадащ маршрут. Заявка, която не изпълнява флаговете на маршрут, продължава към следващия и завършва с 404, когато няма съвпадение; заявка, която не изпълнява `+` или `-`, получава 401. **Маршрут без флагове на същия URL винаги печели пред маршрут с флагове**, затова никога не слагайте и двата на един 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');
}
```