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

Uploaded Source

Built Distribution

Flask_Restler-0.2.2-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.2.tar.gz.

File metadata

File hashes

Hashes for Flask-Restler-0.2.2.tar.gz
Algorithm Hash digest
SHA256 2ad0f7a3ef02ca47ec77111a6277146a3443ea86b13e9184e93eef726293cfd3
MD5 d6b45e29cb6ee19d700af23502440126
BLAKE2b-256 9bbd5c7a1688061e16c036574ff625a56113be01b4aa1b7f24e4d23565529e38

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for Flask_Restler-0.2.2-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 43e9f6b995d49222d00d4fa49b97d68c737ec90dc9ece5500794c7aab4407879
MD5 91e80c83b769d764693085b51179045d
BLAKE2b-256 81743392e3b3c5b36c5a1909b67fad0dbc9b2adda89a5883dfb13a5401499ee8

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