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

This version

1.7.4

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

Uploaded Source

Built Distribution

Flask_Restler-1.7.4-py2.py3-none-any.whl (745.1 kB view details)

Uploaded Python 2 Python 3

File details

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

File metadata

File hashes

Hashes for Flask-Restler-1.7.4.tar.gz
Algorithm Hash digest
SHA256 ff01059b4f65f6cd2a756a9d43884df498913d4f5e115e7516a4f2f277c3a30e
MD5 75a25f0493254aa71f66b595ba6b1881
BLAKE2b-256 0429c9414f9afc68509cd05ec27b52dbb84101dc447c1de4212bebef2e69fb2d

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for Flask_Restler-1.7.4-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 a071520e0e567d73d16b434875b961851d6e9a74f683d195c249064be5d99d85
MD5 000a9b8accf52d8c7d51a68f3287d319
BLAKE2b-256 743ab617c22e2bba9b37e36e8c085dc25cebd8db1763fadb002f3bf5f0300ef9

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