Skip to main content

A small wrapper for flask app to ease the endpoints creation

Project description

A small wrapper for a Flask app to simplify endpoints creation

Motivation

At my company, we’ve been using Flask-RESTful for a lot of projects for the past couple of years, and when we mapped exactly what we need from it, it was mostly the way it allows the user to add routing.

This small module replace for us this functionality, so I’ve decided to share it with whoever want to give it a try :wink:

Getting Started

This wrapper helps divide the Flask App into modules and to use Classes instead of functions for views.

Just run pip install and you are good to go:

$ pip install flask-api-handler

Prerequisites

The only requirement for this project is Flask.

Usage

from flask import Flask
from flask import jsonify
from flask_api_handler import ApiHandler

form example import PaymentHandler

app = Flask(__name__)

# Init the api handler
api = ApiHandler(app)

class UserHandler(object):
    def get(self):
        return jsonify({"user": "user object example"})
    def put(self):
        return jsonify({"user": "update user example"})

# Add the endpoints
api.add_handler('/user', UserHandler)
api.add_handler('/payment', PaymentHandler)

TODO

  • [STRIKEOUT:Make pip installable] - DONE

  • Add tests

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

flask-api-handler-0.1.6.tar.gz (2.7 kB view details)

Uploaded Source

Built Distribution

flask_api_handler-0.1.6-py2-none-any.whl (3.0 kB view details)

Uploaded Python 2

File details

Details for the file flask-api-handler-0.1.6.tar.gz.

File metadata

File hashes

Hashes for flask-api-handler-0.1.6.tar.gz
Algorithm Hash digest
SHA256 cea969dd8079a2ddec3325b08604d420c71970c76e33d5265f711071fa1c74f4
MD5 aa6bb6f611822ce454f7eb1c92303f6c
BLAKE2b-256 d44931e45f6ba140988ce4a966dc5b198ef8f91f7d4157573512e127ae9326cf

See more details on using hashes here.

File details

Details for the file flask_api_handler-0.1.6-py2-none-any.whl.

File metadata

File hashes

Hashes for flask_api_handler-0.1.6-py2-none-any.whl
Algorithm Hash digest
SHA256 cc038a1834af16886ad50f4d08d4797c6103efe6b473fb2bfc9e170949f08dd2
MD5 466a3ab0eb40410c88e2173348334c35
BLAKE2b-256 9956da2d7f604607d393342c6a1134b05031566c87922a05008524433f03792c

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