Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/so1n/pait
Pait(π tool) - Python Modern API Tools, easier to use web frameworks/write API routing
https://github.com/so1n/pait
flask grpc openapi pydantic python redoc sanic starlette swagger tornado type-hints
Last synced: about 11 hours ago
JSON representation
Pait(π tool) - Python Modern API Tools, easier to use web frameworks/write API routing
- Host: GitHub
- URL: https://github.com/so1n/pait
- Owner: so1n
- License: apache-2.0
- Created: 2020-07-22T15:43:34.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2024-10-31T15:04:18.000Z (3 months ago)
- Last Synced: 2025-01-13T23:07:56.139Z (7 days ago)
- Topics: flask, grpc, openapi, pydantic, python, redoc, sanic, starlette, swagger, tornado, type-hints
- Language: Python
- Homepage:
- Size: 4.19 MB
- Stars: 54
- Watchers: 4
- Forks: 3
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
Pait(π tool) - Python Modern API Tools, easier to use web frameworks/write API routing
---
**Documentation**: [https://so1n.me/pait/](https://so1n.me/pait/)
**中文文档**: [https://so1n.me/pait-zh-doc/](https://so1n.me/pait-zh-doc/)
---
# pait
Pait is an api tool that can be used in any python web framework, the features provided are as follows:
- [x] Integrate into the Type Hints ecosystem to provide a safe and efficient API interface coding method.
- [x] Automatic verification and type conversion of request parameters (depends on `Pydantic` and `inspect`, currently supports `Pydantic` V1 and V2 versions).
- [x] Automatically generate openapi files and support UI components such as `Swagger`,`Redoc`,`RapiDoc` and `Elements`.
- [x] TestClient support, response result verification of test cases。
- [x] Plugin expansion, such as parameter relationship dependency verification, Mock response, etc.。
- [x] gRPC GateWay (After version 1.0, this feature has been migrated to [grpc-gateway](https://github.com/python-pai/grpc-gateway))
- [ ] Automated API testing
- [ ] WebSocket support
- [ ] SSE support
> Note:
>
> - mypy check 100%
>
> - python version >= 3.8 (support postponed annotations)
# Installation
```Bash
pip install pait
```
# Simple Example
```python
import uvicorn # type: ignore
from starlette.applications import Starlette
from starlette.responses import JSONResponse
from starlette.routing import Route
from pait.app.starlette import pait
from pait.field import Body
from pait.openapi.doc_route import add_doc_route
from pydantic import BaseModel, Field
class ResponseModel(BaseModel):
"""demo response"""
uid: int = Field()
user_name: str = Field()
@pait(response_model_list=[ResponseModel])
async def demo_post(
uid: int = Body.i(description="user id", gt=10, lt=1000),
user_name: str = Body.i(description="user name", min_length=2, max_length=4)
) -> JSONResponse:
return JSONResponse({'uid': uid, 'user_name': user_name})
app = Starlette(routes=[Route('/api', demo_post, methods=['POST'])])
add_doc_route(app)
uvicorn.run(app)
```
See [documentation](https://so1n.me/pait/) for more features
# Support Web framework
| Framework | Description |
|-----------|------------------------|
| Flask | All features supported |
| Sanic | All features supported |
| Starlette | All features supported |
| Tornado | All features supported |
| Django | Coming soon |
If the web framework is not supported(which you are using).
Can be modified sync web framework according to [pait.app.flask](https://github.com/so1n/pait/blob/master/pait/app/flask.py)
Can be modified async web framework according to [pait.app.starlette](https://github.com/so1n/pait/blob/master/pait/app/starlette.py)
# Performance
The main operating principle of `Pait` is to convert the function signature of the route function into `Pydantic Model` through the reflection mechanism when the program is started,
and then verify and convert the request parameters through `Pydantic Model` when the request hits the route.
These two stages are all automatically handled internally by `Pait`.
The first stage only slightly increases the startup time of the program, while the second stage increases the response time of the routing, but it only consumes 0.00005(s) more than manual processing.
The specific benchmark data and subsequent optimization are described in [#27](https://github.com/so1n/pait/issues/27).
# Example
For more complete examples, please refer to [example](https://github.com/so1n/pait/tree/master/example)