Skip to main content

Build REST API for Flask using Marshmallow.

Project description

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

Has builded support for SQLAlchemy and Peewee ORM.

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!'


# Regiater 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-0.2.4.tar.gz (717.6 kB view details)

Uploaded Source

Built Distribution

Flask_Restler-0.2.4-py2.py3-none-any.whl (738.3 kB view details)

Uploaded Python 2 Python 3

File details

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

File metadata

File hashes

Hashes for Flask-Restler-0.2.4.tar.gz
Algorithm Hash digest
SHA256 2903f4423b911a332012730e2bb4057be3c856853b3ae441bebcdc86ae66deb1
MD5 2e8d1d648be2934d7688bf26a3cb67cb
BLAKE2b-256 b67d484761fb807929ce2e714303591edd64d6a53423cc424972a3657b517979

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for Flask_Restler-0.2.4-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 0fe2dc78f5316f73848da51c446757c359124d2846dc3b4fbc6080b0db48d686
MD5 36b082bf996100aaf36bf658b6c65a03
BLAKE2b-256 0edf09de58c7b960258e7385fae79f08941d3d85918498296fdb0a0568611e28

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