Controllers

Controller in Nestipy look like

Python

from nestipy.common import Controller, Get


@Controller('cats')
class CatsController:
    @Get()
    async def find_all(self) -> str:
        return 'This action returns all cats'

Request and Response object

We can access Request and Response object from handler bu using annotation type Req and Res respectively.

Python

from typing import Annotated
from nestipy.ioc import Req, Res

from nestipy.common import Controller, Get, Response, Request


@Controller('cats')
class CatsController:
    @Get()
    async def find_all(self, req: Annotated[Request, Req()], res: Annotated[Response, Res()]) -> Response:
        return await res.send('This action returns all cats')

Full resource sample

Below is a sample illustrating how different decorators are employed to create a basic controller. This controller furnishes methods for accessing and modifying internal data.

Python

from dataclasses import dataclass
from typing import Annotated

from nestipy.common import Controller, Get, Put, Post, Delete
from nestipy.ioc import Body, Query, Param, Session, Header


@dataclass
class CreateCat:
    name: str


@Controller('cats')
class CatsController:

    @Post()
    async def create(self, data: Annotated[CreateCat, Body()]) -> str:
        return 'This action adds a new cat'

    @Get()
    async def find_all(self, limit: Annotated[int, Query('limit')], headers: Annotated[dict, Header()]) -> str:
        return f"This action returns all cats (limit: {limit} items"

    @Get('/{cat_id}')
    async def find_one(self, cat_id: Annotated[str, Param('cat_id')]):
        return f"This action returns a #{cat_id} cat"

    @Put('/{cat_id}')
    async def update(self, cat_id: Annotated[str, Param('cat_id')], data: Annotated[CreateCat, Body()]):
        return f"This action updates a #{cat_id} cat"

    @Delete('/{cat_id}')
    async def remove(self, cat_id: Annotated[str, Param('cat_id')], user_id: Session[int, None]):
        return f"This action removes a #{cat_id} cat"

Getting up and running

Similar to NestJs, registering controllers within modules is required.

Python

from nestipy.common import Module
from .cats_controller import CatsController


@Module(
    controllers=[
        CatsController
    ]
)
class AppModule:
    pass

Take a look here for an example.

Support us

Nestipy is a project released under the MIT license, meaning it's open source and freely available for use and modification. Its development thrives with the generous contributions of these fantastic individuals.