The package provides enhanced support for writing REST APIs with Muffin framework
Project description
Muffin-REST – provides enhanced support for writing REST APIs with Muffin.
Features
API class to simplify the creation of REST APIs;
Automatic filtering and sorting for resources;
Support for Peewee ORM, Mongo, SQLAlchemy Core;
Auto documentation with Swagger;
Requirements
python >= 3.7
Installation
Muffin-REST should be installed using pip:
pip install muffin-rest
With SQLAlchemy Core support:
pip install muffin-rest[sqlalchemy]
With Peewee ORM support:
pip install muffin-rest[peewee]
With YAML support for autodocumentation:
pip install muffin-rest[yaml]
Usage
Create an API:
from muffin_rest import API
api = API()
Create endpoints and connect them to the API (example for sqlalchemy):
from muffin_rest.sqlalchemy import SAEndpoint
from project.api import api
@api.route
class MyEndpoint(SAEndpoint):
class Meta:
table = MyTable
database = db
Connect it to your Muffin application:
from project.api import api
api.setup(app, prefix='/api/v1')
Bug tracker
If you have any suggestions, bug reports or annoyances please report them to the issue tracker at https://github.com/klen/muffin-rest/issues
Contributing
Development of Muffin-REST happens at: https://github.com/klen/muffin-rest
Contributors
klen (Kirill Klenov)
License
Licensed under a MIT license.
Project details
Release history Release notifications | RSS feed
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
Hashes for muffin_rest-8.0.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 5868eda7632dff8843b75e6b1c33fa8d350ba89ae26b4950def383f6af2c62d5 |
|
MD5 | 5254b6d0c7812919e42c78e20bae14dd |
|
BLAKE2b-256 | f1765f8dfff7cc69327a782f89a2b2e521a7fc041278b5256e166c251208f323 |