This release is a pre-release and may not be stable for production use.
CheeseAPI
一款协程友好的 web 框架
该框架为个人设计,仅供学习交流使用,各种 API 目前不会保证稳定性和向后兼容性
安装
pip install CheeseAPI
依赖
日志系统,CheeseAPI 使用它进行日志的输出与记录
信号系统,CheeseAPI 使用它进行所有事件信号的管理与分发
项目结构
CheeseAPI采用模块结构:
| - User
| - __init__.py
| - model.py
| - api.py
| - scheduler.py
| - service.py
| - handle.py
| - validator.py
| - Permission
| - __init__.py
| - model.py
| - api.py
| - service.py
| - validator.py
| - __init__.py
| - app.py
CheeseAPI 并没有强制规定文件名,但建议的文件命名方式如下:
| 文件名 | 备注 |
|---|---|
| __init__.py | 公用变量 |
| model.py | ORM或类 |
| api.py | API接口 |
| scheduler.py | 定时任务 |
| service.py | 业务逻辑实现 |
| handle.py | 运行逻辑 |
| validator.py | 参数校验 |
使用
创建一个 app 文件 app.py:
from CheeseAPI import CheeseAPI, Response
app = CheeseAPI()
@app.route.get('/')
async def index(**kwargs):
return Response('这里是CheeseAPI!')
若在单文件中运行,继续添加入口即可
if __name__ == '__main__':
app.run()
若在多文件项目中运行,可创建一个 manage.py 入口文件
from app import app
if __name__ == '__main__':
app.run()
运行入口文件即可
示例
在 examples 目录下有一些示例项目,可以参考学习
文档
1. CheeseAPI(主模块)
2. Route(路由)
3. Request
4. Response
5. Websocket
6. File
7. Validator(数据校验)
8. Signal
9. Scheduler(任务调度)
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file cheeseapi-2.0.8b7.tar.gz.
File metadata
- Download URL: cheeseapi-2.0.8b7.tar.gz
- Upload date:
- Size: 28.1 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via:
twine/7.0.0 CPython/3.13.13
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
f3dd1223605e492f466bcef0bae7d3381de1c7f4cb02b66620bd6531af7e3908
|
|
| MD5 |
86e4dcdd6e91bfc5583adb3e432532f8
|
|
| BLAKE2b-256 |
a560318d1d8ddff9dede909bd39345c9fb9cf1947978d4d39d52b0c52e3c5234
|
File details
Details for the file cheeseapi-2.0.8b7-py2.py3-none-any.whl.
File metadata
- Download URL: cheeseapi-2.0.8b7-py2.py3-none-any.whl
- Upload date:
- Size: 33.9 kB
- Tags: Python 2, Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via:
twine/7.0.0 CPython/3.13.13
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
bf30cb6176fd85741d553d565af6f67de16812bbb41f24cb6adff7190a2fadf3
|
|
| MD5 |
a6fe2bb6fb8ff43af91bbdefe4e4db67
|
|
| BLAKE2b-256 |
54454820121414f7b8b3b8c88d44c52860eb3e87d934e417e7e95d86c86f30ee
|