sanic/docs/routing.md
João Costa ce7a34b608 Update routing.md <PARAM>
Some markdown readers (such as github's preview) parse `<PARAM>` as an HTML tag.

Wrapping it in a code block fixes that.
2016-10-15 19:30:44 +01:00

1.2 KiB

Routing

Sanic comes with a basic router that supports request parameters. To specify a parameter, surround it with carrots like so: <PARAM>. Request parameters will be passed to the request handler functions as keyword arguments. To specify a type, add a :type after the parameter name, in the carrots. If the parameter does not match the type supplied, Sanic will throw a NotFound exception, resulting in a 404 page not found error.

Examples

from sanic import Sanic
from sanic.response import text

@app.route('/tag/<tag>')
async def person_handler(request, tag):
	return text('Tag - {}'.format(tag))

@app.route('/number/<integer_arg:int>')
async def person_handler(request, integer_arg):
	return text('Integer - {}'.format(integer_arg))

@app.route('/number/<number_arg:number>')
async def person_handler(request, number_arg):
	return text('Number - {}'.format(number))

@app.route('/person/<name:[A-Za-z]>')
async def person_handler(request, person_id):
	return text('Person - {}'.format(folder_id))

@app.route('/folder/<folder_id:[A-Za-z0-9]{0,4}>')
async def folder_handler(request, folder_id):
	return text('Folder - {}'.format(folder_id))