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

Uploaded Source

Built Distribution

Flask_Restler-0.4.1-py2.py3-none-any.whl (741.0 kB view details)

Uploaded Python 2 Python 3

File details

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

File metadata

File hashes

Hashes for Flask-Restler-0.4.1.tar.gz
Algorithm Hash digest
SHA256 c75d5d3fe7cb05ddbc9ad5ec1c3623e63ea3a7f76f5fd5348a96c4f178480edf
MD5 8341f9314cfb75c15c3e7077b6666a86
BLAKE2b-256 288416b341a4f601470a988c980079de6a409674edd8ccfce6c2c81adaa52296

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for Flask_Restler-0.4.1-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 a5f3ad45f91a45496f75adbe1bc43a221ea0bf02e81fe3d1b35fc4e39311b342
MD5 5cd584595a880ce97e9f3673ee154cfc
BLAKE2b-256 edefab0190c5d6214f68aa72d739c13fc8a6e5f1e3f8d31f54d34b4bc65624d5

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