Routes

Routing

In Pykour, routes are defined using the route() decorator, which takes a URL path.

@app.route('/')
def index():
    return { "message": "Index Page" }

@app.route('/hello')
def hello():
    return { "message": "Hello, Pykour!" }

By default, the route() decorator defines routes with the GET method. If you want to use HTTP methods other than GET, you can explicitly specify the HTTP method.

@app.route('/hello', method="POST")
def post_hello():
    return { "message": "Hello, Pykour!" }

The route() decorator also defines routes with a default status code of 200 OK. If you want to change the status code, you can specify it using the status_code argument.

@app.route('/hello', method="POST", status_code=201)
def post_hello():
    return { "message": "Hello, Pykour!" }

Variables in Routes

You can also use variables within the route path.

@app.route('/hello/{name}')
def hello_name(name):
    return { "message": f"Hello, {name}!" }

{name} or :name maps to the name argument. By default, it maps to the str type, but it can also map to int or float based on the type hint.

@app.route('/users/:age')
def user_age(age: int):
    return { "message": f"User age is {age}" }

When receiving data with POST or PUT methods, you can accept data as a dictionary.

@app.route('/users', method="POST")
def create_user(data: dict):
    return { 'message': 'User created', 'name': data['name'] }

Additionally, you can receive data using a schema.

from pykour.schema import BaseSchema

class UserSchema(BaseSchema):
    name: str
    age: int


@app.route('/users', method="POST")
def create_user(data: UserSchema):
    return { 'message': 'User created', 'name': data.name }

HTTP Methods

In a REST API, different HTTP methods are used. Pykour provides decorators corresponding to each HTTP method.

The get(), post(), put(), delete(), and patch() decorators are shortcuts for the route() decorator.

@app.get('/')
def get():
    ...

@app.post('/')
def post():
    ...

@app.put('/')
def put():
    ...

@app.delete('/')
def delete():
    ...

@app.patch('/')
def patch():
    ...

If you want to support the OPTIONS and HEAD methods, you can use the options() and head() decorators. Pykour handles the response for the OPTIONS and HEAD methods, so you only need to declare an empty method.

@app.options('/')
def options():
    ...

@app.head('/')
def head():
    ...

The TRACE method is not supported for security reasons.

Methods other than GET, POST, PUT, DELETE, PATCH, OPTIONS, and HEAD cannot be set with the route() decorator, and shortcut decorators are not provided. If an unsupported HTTP method is accessed, Pykour will return a 404 Not Found status code.