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

Uploaded Source

Built Distribution

Flask_Restler-0.1.0-py2.py3-none-any.whl (738.1 kB view details)

Uploaded Python 2 Python 3

File details

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

File metadata

File hashes

Hashes for Flask-Restler-0.1.0.tar.gz
Algorithm Hash digest
SHA256 f00723762f66ab8bb1a7a48faa742ae4059ff4b666e9665df391bcef2e5bb399
MD5 f30f879ed11e06258dfe31548e989451
BLAKE2b-256 8bb3875dd986b22278ba70d0dc4077a27b759a00fb432d5fdc0cf9cc7be2f929

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for Flask_Restler-0.1.0-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 caee512c96ae0fcb43f5b99147f035c952facc5dbf864fe7b2aab508a34171ed
MD5 53d7e03168db168c6e64cb286be14de6
BLAKE2b-256 9b325c31bcf17e5e07a5e01886d7be79d707150f739b9b39834a919a654c1cae

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