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


# 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-1.1.1.tar.gz (720.3 kB view details)

Uploaded Source

Built Distribution

Flask_Restler-1.1.1-py2.py3-none-any.whl (743.1 kB view details)

Uploaded Python 2 Python 3

File details

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

File metadata

File hashes

Hashes for Flask-Restler-1.1.1.tar.gz
Algorithm Hash digest
SHA256 e96e5fc520424e8482ccf2e3998063506b3540c3a2bbabf6ec027be28501435b
MD5 905f9009e96582d6bd3f93816e08b3da
BLAKE2b-256 cb8f00d122bcca458f1aae5598bb1efb23d3f15d5ceb33a4f6b588018916bb37

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for Flask_Restler-1.1.1-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 23ca908c2a3654dc8f74bfdf046f86f73ebfcef9ed56f4bf8291b5f7eb843aee
MD5 4e87789eadde805778ddfb98d33c0ec9
BLAKE2b-256 75336b0cb18ba4bb96ecf39666821858dc4f5f1d107ec2456f927c7407a424dc

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