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.12.0.tar.gz (461.0 kB view details)

Uploaded Source

Built Distribution

Flask_Restler-1.12.0-py2.py3-none-any.whl (466.1 kB view details)

Uploaded Python 2 Python 3

File details

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

File metadata

File hashes

Hashes for Flask-Restler-1.12.0.tar.gz
Algorithm Hash digest
SHA256 d04a39618e0f92d94d58c95cfabf4b4eaa7986365e30fbf3faf50a4ef87b2f57
MD5 d29ab8574a086729308227acc5e6a120
BLAKE2b-256 208754d0dfb3dc3fb9c4504b3323046e2cbd1c3c0574e749eb75ee8264c8726b

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for Flask_Restler-1.12.0-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 ee5ebf59e9a148470f193e11075cdd7f8533390a4faa0f528556b39c33016fd6
MD5 e9f43b1203b2f81c0a4892fb2880d30f
BLAKE2b-256 73ad8354ca247886661239445ce5fc6d069151d93ed3d71ff8f9847075c2935d

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