Syntax trasy Total.js 5

Total.js 5 · total5@0.0.19 referenceroutingsyntax Spuštěno s Total.js 5

ROUTE(definition, handler) deklaruje routu. Definice je jeden text s těmito částmi v tomto pořadí:

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

Část	Význam
`METHOD`	`GET`, `POST`, `PUT`, `PATCH`, `DELETE`, nebo `SOCKET` pro WebSocket a `FILE` pro URL s příponou: URL jako `/a.txt` nikdy nevyhovuje route `GET`.
`+` nebo `-` před metodou	`+` přijímá pouze požadavky, které `AUTH()` schválilo, `-` pouze anonymní; každý jiný požadavek dostane 401. Bez prefixu je routa otevřená.
`/url/`	Cesta. Napište koncové lomítko: routy se s ním porovnávají.
`{name}`	Segment cesty, který se čte z `$.params.name`.
`*` jako poslední segment	Vyhovuje libovolné cestě pod ním. Routa bez `*` je konkrétnější a vyhrává.
`@flag`	Podmínka pro požadavek: `@json`, `@xml`, `@xhr`, `@upload`, `@debug`, `@release`, `@mobile`, `@robot`, `@referer` (nebo `@referrer`).
`#name`	Middleware zaregistrovaný přes `MIDDLEWARE(name, fn)`.
`<limit`	`<10kb` omezuje velikost těla, `<30s` dobu požadavku.
`--> *Action`	Spustí jednu nebo více akcí se vstupem požadavku a odpoví výsledkem.
`#404`, `#401`...	Routa, jejíž definice je pouze `#` a stavový kód, nahradí chybovou stránku.

Požadavek obslouží první vyhovující routa. Požadavek, který nesplňuje příznaky routy, pokračuje na další routu a skončí chybou 404, pokud nevyhovuje žádná; požadavek, který nesplňuje + nebo -, dostane 401. Routa bez příznaků na stejné URL vždy vyhraje nad routou s příznaky, proto nikdy nedávejte obě na jednu URL.

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

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