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

Uploaded Source

Built Distribution

Flask_Restler-1.17.0-py2.py3-none-any.whl (467.3 kB view details)

Uploaded Python 2 Python 3

File details

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

File metadata

File hashes

Hashes for Flask-Restler-1.17.0.tar.gz
Algorithm Hash digest
SHA256 e39ae073f0293234629054a04067bd7847d9bb0c8fc649e836d8babe46d387cb
MD5 934c1e45e875193ff7bba1c4c687175f
BLAKE2b-256 2cdcd7f571481e80f8bc7d4d1eb3065d73ef48d52e3ce6174e4a10fd8fb46959

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for Flask_Restler-1.17.0-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 e7d397942b8f348b8878fd911d67616b14008ebc91c76f8315eb04f6279e06e2
MD5 ef5be81384f839fe79a03ba892df8dcf
BLAKE2b-256 b71c9fcbf58281fd55654a8991d6d6e955024f2dd761caa96c3fc924832764c9

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