该软件包提供了对使用Muffin框架编写REST API的增强支持
项目描述
Muffin-REST – 为使用 Muffin 提供增强的REST API编写支持。
特性
API类简化REST API的创建;
资源的自动过滤和排序;
使用 Swagger 自动生成文档;
要求
python >= 3.9
安装
Muffin-REST 应使用pip安装
pip install muffin-rest
pip install muffin-rest[sqlalchemy]
支持 Peewee ORM
pip install muffin-rest[peewee]
支持自动文档的YAML
pip install muffin-rest[yaml]
使用
创建API
from muffin_rest import API
api = API()
创建端点并将它们连接到API(sqlalchemy示例)
from muffin_rest.sqlalchemy import SAEndpoint
from project.api import api
@api.route
class MyEndpoint(SAEndpoint):
class Meta:
table = MyTable
database = db
将其连接到您的 Muffin 应用程序
from project.api import api
api.setup(app, prefix='/api/v1')
错误追踪器
如果您有任何建议、错误报告或烦恼,请向 https://github.com/klen/muffin-rest/issues 的问题跟踪器报告
贡献
Muffin-REST 的开发地址为: https://github.com/klen/muffin-rest
贡献者
klen (Kirill Klenov)
许可证
许可协议为 MIT 许可。
项目详情
下载文件
下载适合您平台的文件。如果您不确定选择哪个,请了解更多关于 安装包 的信息。
源码分布
muffin_rest-8.1.0.tar.gz (25.4 kB 查看哈希值)
构建分布
muffin_rest-8.1.0-py3-none-any.whl (36.3 kB 查看散列值)
关闭
muffin_rest-8.1.0.tar.gz 的散列值
算法 | 散列摘要 | |
---|---|---|
SHA256 | c097827c367aa7e15877b807fdc2868a46132fa2c8ce3951b9ed032d72d34f21 |
|
MD5 | 2ce9eaca1e320f21be1efdd2604013d9 |
|
BLAKE2b-256 | 5af84ce337a32ca5765dd051001df656452ea00a0f1264c2c23424168d07eb9a |
关闭
muffin_rest-8.1.0-py3-none-any.whl 的散列值
算法 | 散列摘要 | |
---|---|---|
SHA256 | 44962da4345dc2d1a565e921133bc57c31a87cfe5023ea50e8611a5a9e552a4f |
|
MD5 | f09821002ed106456e88f519de6ce37d |
|
BLAKE2b-256 | cc731d58e2108c27c23889e0e06d929701f2caee9d83e2da58510763c60dd32c |