# Syntax drogi Total.js 5

> Deklaracja trasy Total.js z metodami, parametrami URL, mapami, flagi, autentycznością, środkowym oprogramowaniem i działaniami.

Framework: total5
Product: Total.js 5 (total5@0.0.19)
Language: pl
Content-SHA256: 09fec9cb29cce9f6b63ee53125b78976a0bfaea0b03c9513c9aa2975cb1deab8
Snapshot: c0700e321579725c5cf4f5ace1ad7d2866d1b4f93c24a63c0b41b6b7998e976c
Sources: total5-installed@total5@0.0.19
Review: not-recorded

`ROUTE(definition, handler)` deklaruje trasę. Definicja to jeden tekst z tymi częściami, w tej kolejności:

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

| Część | Znaczenie |
|---|---|
| `METHOD` | `GET`, `POST`, `PUT`, `PATCH`, `DELETE`, lub `SOCKET` dla WebSocket i `FILE` dla adresów z rozszerzeniem: adres taki jak `/a.txt` nigdy nie pasuje do trasy `GET`. |
| `+` lub `-` przed metodą | `+` przyjmuje tylko żądania zatwierdzone przez `AUTH()`, `-` tylko anonimowe; każde inne żądanie otrzymuje 401. Bez prefiksu trasa jest otwarta. |
| `/url/` | Ścieżka. Napisz końcowy ukośnik: trasy są dopasowywane z nim. |
| `{name}` | Segment ścieżki odczytywany z `$.params.name`. |
| `*` jako ostatni segment | Pasuje do dowolnej ścieżki poniżej. Trasa bez `*` jest bardziej szczegółowa i wygrywa. |
| `@flag` | Warunek dla żądania: `@json`, `@xml`, `@xhr`, `@upload`, `@debug`, `@release`, `@mobile`, `@robot`, `@referer` (lub `@referrer`). |
| `#name` | Middleware zarejestrowany przez `MIDDLEWARE(name, fn)`. |
| `<limit` | `<10kb` ogranicza rozmiar treści, `<30s` czas żądania. |
| `--> *Action` | Uruchamia jedną lub więcej akcji z wejściem żądania i odpowiada wynikiem. |
| `#404`, `#401`... | Trasa, której definicja to tylko `#` i kod statusu, zastępuje stronę błędu. |

Żądanie obsługuje pierwsza pasująca trasa. Żądanie, które nie spełnia flag trasy, przechodzi do następnej i kończy się błędem 404, gdy żadna nie pasuje; żądanie, które nie spełnia `+` lub `-`, otrzymuje 401. **Trasa bez flag na tym samym adresie zawsze wygrywa z trasą z flagami**, więc nigdy nie umieszczaj obu na jednym adresie.

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