Skip to main content

Build REST API for Flask using Marshmallow.

Project description

Build Status Version Downloads

The Flask RESTler – Build REST API for Flask using Marshmallow.

Has builded support for SQLAlchemy, Peewee ORM and Pymongo.

Example “Hello User” with the Flask-resler:

from flask_restler import Api, Resource


# flask_restler.Api is subclass of Flask.Blueprint
api = Api('My awesome API', __name__, url_prefix='/api/v1')

# flask_restler.Resource is subclass of Flask.views.View
@api.connect
class HelloResource(Resource):

    def get(self, resource=None):
        return 'Hello World!'


# Register with your application
from your_project import app

app.register_blueprint(api)

if __name__ == '__main__':
    app.run()

Run the application and open http://localhost:5000/api/v1/ in your browser.

Requirements

  • python 2.7+,3.4+

Installation

Flask-RESTler should be installed using pip:

pip install flask-restler

Usage

Docs in progress. Would like to help? Create a PR.

Bug tracker

If you have any suggestions, bug reports or annoyances please report them to the issue tracker at https://github.com/klen/flask-restler/issues

Contributing

Development of The Flask-restler happens at: https://github.com/klen/flask-restler

Contributors

License

Licensed under a MIT license (See LICENSE)

If you wish to express your appreciation for the project, you are welcome to send a postcard to:

Kirill Klenov
pos. Severny 8-3
MO, Istra, 143500
Russia

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

Flask-Restler-1.15.0.tar.gz (461.7 kB view details)

Uploaded Source

Built Distribution

Flask_Restler-1.15.0-py2.py3-none-any.whl (467.0 kB view details)

Uploaded Python 2 Python 3

File details

Details for the file Flask-Restler-1.15.0.tar.gz.

File metadata

File hashes

Hashes for Flask-Restler-1.15.0.tar.gz
Algorithm Hash digest
SHA256 9da0928a8126dba2c449962402c4603132b654e6cc51ef14ae3256f6c33f36ab
MD5 c1bb6fbf962b973fcc4e00eaa26c7d6f
BLAKE2b-256 94335c8e9fcd45494def8255483fa773ddf9b43819eacd6b287a67c13d209865

See more details on using hashes here.

File details

Details for the file Flask_Restler-1.15.0-py2.py3-none-any.whl.

File metadata

File hashes

Hashes for Flask_Restler-1.15.0-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 ccd95a43caeb3830b2ccf9b25e9e6bb5cc74c93d80a290c0b43f4d8725cace42
MD5 42b745421ae3c72d83cd46e7f05c0321
BLAKE2b-256 a4669d7c13d4d4fb57d59fb717592accc2b3175e11012fd4a5985a9b1832619a

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page