gr1n / aioapi

Yet another way to build APIs using AIOHTTP framework

aioapi

Yet another way to build APIs using AIOHTTP framework.

Follow documentation to know what you can do with AIOAPI.

Installation

$ pip install aioapi

Usage & Examples

Below you can find a simple, but powerful example of AIOAPI library usage:

import aioapi as api
from aioapi import Body, PathParam
from aioapi.middlewares import validation_error_middleware
from aiohttp import web
from pydantic import BaseModel


class User(BaseModel):
    name: str
    age: int = 42


async def hello_body(user_id: PathParam[int], body: Body[User]):
    user = body.cleaned
    return web.json_response(
        {"id": user_id.cleaned, "name": user.name, "age": user.age}
    )


def main():
    app = web.Application()

    app.add_routes([api.post("/hello/{user_id}", hello_body)])
    app.middlewares.append(validation_error_middleware)

    web.run_app(app)


if __name__ == "__main__":
    main()

And there are also more examples of usage at examples/ directory.

To run them use command below:

$ make example

Contributing

To work on the AIOAPI codebase, you'll want to clone the project locally and install the required dependencies via poetry:

$ git clone [email protected]:Gr1N/aioapi.git
$ make install

To run tests and linters use command below:

$ make lint && make test

If you want to run only tests or linters you can explicitly specify what you want to run, e.g.:

$ make lint-black

Milestones

If you're interesting in project's future you can find milestones and plans at projects page.

License

AIOAPI is licensed under the MIT license. See the license file for details.

aioapi's Issues

Cookie parameters

TBD

Path parameters

In aiohttp resources may have variables, for example:

@routes.get('/{name}')
async def variable_handler(request):
    return web.Response(text=f"Hello, {request.match_info['name']}")

...or:

web.get(r'/{name}', variable_handler)

And we need to implement a possibility to validate such cases.

It can be implemented in a way:

class View(TypedView):
    async def get(self, name: str):
        pass

Also, we need to think about how can we optionally declare metadata for future integration with OpenAPI.

Support CBV

Need to add support for class-based views.

At a glance:

class HelloView(web.View):
    async def get(self, request: web.Request, name: PathParam[str]):
        ...

    async def post(self, body: Body[HelloBodyRequest]):
        ...

Rename project to `aioapi`

Rename project to aioapi

Nested components

TBD

Request body

Need to have possibility to validate request body.

At a glance:

class Request(BaseModel):
    pass

async def handle(body: tpd.Body[Request]):
    pass

Think about defaults and should we allow to have the ability to specify multiple parameters like fastapi did or not.

Tests

Tests!

Initial Update

The bot created this issue to inform you that pyup.io has been set up on this repo.
Once you have closed it, the bot will open pull requests for updates as soon as they are available.

Header parameters

Need to have possibility to validate headers.

At a glance:

async def handle(locale: Header[str]):
    pass

Also, we can specify defaults:

async def handle(locale: Header[str] = "ru"):
    pass

Support RouteTableDef

TBD

Response body

TBD

Better exceptions

Need to improve repl for existing exceptions.

Documentation

Documentation!

Request object

Need to have possibility to pass request object.

At a glance:

async def handle(request: web.Request):
    pass

Query parameters

Need to have possibility to validate query parameters.

At a glance:

async def handle(name: tpd.QueryParam[str]):
    pass

Also, we can specify defaults:

async def handle(name: tpd.QueryParam[str] = "batman"):
    pass

Custom bad request error handler

Need possibility to pass custom error handler to override default one.