Erstellen von RESTful-APIs mit Flask: ORM-unabhängig

() translation by (you can also view the original English article)

Im ersten Teil dieser dreiteiligen Tutorial-Reihe haben wir gesehen, wie RESTful-APIs mithilfe von Flask als Webframework selbst geschrieben werden. Im zweiten Teil haben wir eine RESTful-API mit Flask-Restless erstellt, die von SQLAlchemy als ORM abhängt. In diesem Teil verwenden wir eine andere Flask-Restful, Flask-Restful, die Ihr ORM abstrahiert und keine Annahmen darüber macht.

Ich werde dieselbe Beispielanwendung wie im letzten Teil dieser Reihe verwenden, um den Kontext und die Kontinuität aufrechtzuerhalten. Obwohl diese Beispielanwendung auf SQLAlchemy selbst basiert, kann diese Erweiterung zusammen mit jedem ORM auf ähnliche Weise verwendet werden, wie in diesem Tutorial gezeigt.

Abhängigkeiten installieren

Während wir mit der Anwendung aus dem ersten Teil fortfahren, müssen wir nur eine Abhängigkeit installieren:

1	$ pip install Flask-Restful

Die Anwendung

Bevor wir beginnen, möchten Sie möglicherweise den Code entfernen, den wir für den zweiten Teil dieser Lernserie geschrieben haben, um mehr Klarheit zu schaffen.

Wie immer beginnen wir mit Änderungen an der Konfiguration unserer Anwendung, die ungefähr wie die folgenden Codezeilen aussehen:

flask_app/my_app/init.py

1	from flask.ext.restful import Api
2
3	api = Api(app)

Es sollte ausreichen, nur die obigen Zeilen zum vorhandenen Code hinzuzufügen.

lask_app/my_app/catalog/views.py

import json
from flask import Blueprint, abort
from flask.ext.restful import Resource
from flask.ext.restful import reqparse
from my_app.catalog.models import Product
from my_app import api, db


catalog = Blueprint('catalog', __name__)

parser = reqparse.RequestParser()
parser.add_argument('name', type=str)
parser.add_argument('price', type=float)


@catalog.route('/')
@catalog.route('/home')
def home():
    return "Welcome to the Catalog Home."


class ProductApi(Resource):

    def get(self, id=None, page=1):
        if not id:
            products = Product.query.paginate(page, 10).items
        else:
            products = [Product.query.get(id)]
        if not products:
            abort(404)
        res = {}
        for product in products:
            res[product.id] = {
                'name': product.name,
                'price': product.price,
            }
        return json.dumps(res)

    def post(self):
        args = parser.parse_args()
        name = args['name']
        price = args['price']
        product = Product(name, price)
        db.session.add(product)
        db.session.commit()
        res = {}
        res[product.id] = {
            'name': product.name,
            'price': product.price,
        }
        return json.dumps(res)

api.add_resource(
   ProductApi,
   '/api/product',
   '/api/product/<int:id>',
   '/api/product/<int:id>/<int:page>'
)

Der größte Teil des obigen Codes ist selbsterklärend. Ich werde jedoch einige Punkte hervorheben. Der obige Code scheint dem im ersten Teil dieser Serie sehr ähnlich zu sein, aber hier führt die verwendete Erweiterung eine Reihe von Optimierungen hinter den Kulissen durch und bietet viel mehr Funktionen, die genutzt werden können.

Hier werden die Methoden, die unter einer Klasse deklariert sind, die Resource unterordnet, automatisch für das Routing berücksichtigt. Außerdem müssen alle Parameter, die wir zusammen mit eingehenden HTTP-Aufrufen erwarten, mit reqparse analysiert werden.

Testen der Anwendung

Diese Anwendung kann genauso getestet werden wie im zweiten Teil dieser Tutorial-Reihe. Ich habe die Routing-URL für den gleichen Zweck gleich gehalten.

Abschluss

In diesem letzten Teil dieser dreiteiligen Lernserie zur Entwicklung von RESTful-APIs mit Flask haben wir gesehen, wie ORM-unabhängige RESTful-APIs geschrieben werden. Dies fasst die Grundlagen des Schreibens von RESTful-APIs mit Flask auf verschiedene Arten zusammen.

Zu jeder der behandelten Methoden können Sie mehr lernen, und Sie können dies anhand der in dieser Reihe erlernten Grundlagen selbst untersuchen.