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

Uploaded Source

Built Distribution

Flask_Restler-0.2.8-py2.py3-none-any.whl (738.4 kB view details)

Uploaded Python 2 Python 3

File details

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

File metadata

File hashes

Hashes for Flask-Restler-0.2.8.tar.gz
Algorithm Hash digest
SHA256 1e07e26608cbe24be9d6e9f6b1eff9ef04a87f1f0f074eaba6092796853d0ff0
MD5 5732d10795e94d71c553eddebe740578
BLAKE2b-256 26f3d61ca0c210676da5e1b9db5f0c0caf4141525e57adbce2645e1f4c1b052d

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for Flask_Restler-0.2.8-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 38cd1c050853f1477af0e437474df4f69432ef49f4a33d910dcaa571134fe6bf
MD5 bf02ff662bbdb23f0d2bc44174c8b7b7
BLAKE2b-256 2f48c5cf1c884b33ab9e1df837ed58eadf123146f77f08b9978196d75bd25ee2

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