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

Uploaded Source

Built Distribution

Flask_Restler-1.5.0-py2.py3-none-any.whl (744.6 kB view details)

Uploaded Python 2 Python 3

File details

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

File metadata

File hashes

Hashes for Flask-Restler-1.5.0.tar.gz
Algorithm Hash digest
SHA256 303317e0d70100c3db18bc1d287b19f6025d9fcab09f42a6aabe7f4ab7a95549
MD5 754c9d3622a8b6bf068d9b3448062d7d
BLAKE2b-256 fa6811e83fa395229d90758e8d1825ba34d236b6d14108731ff03552c69e2e58

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for Flask_Restler-1.5.0-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 a22afcf438130621b96a024ae6be3933f5a70c5419d5818dcd59ef1360b9b8cc
MD5 b50e86d7262019dea1c04f79f2c4ded3
BLAKE2b-256 196c269fea9a934f9bb7e9d093c37c21e20cdee884c7b7fbf95d4f643ca0d268

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