DY

DelahayeYourself

modules / LP Web Dynamique /

TP10: API REST

Nous avons découvert comment requêter une API REST, il est donc temps de découvrir comment en créer une.

Flask-RESTful

Flask-RESTful est une extension pour Flask qui prend en charge la création rapide d’API REST. C'est une abstraction légère qui fonctionne avec les ORM existants.

Installation

Comme toujours ?

pipenv install flask-restful
Démarrage rapide

Il est temps d’écrire notre première API REST.

Une API Flask-RESTful minimale ressemble à ceci:

from flask import Flask
from flask_restful import Resource, Api

app = Flask(__name__)
api = Api(app)

class HelloWorld(Resource):
    def get(self):
        return {'hello': 'world'}

api.add_resource(HelloWorld, '/')

Vous savez désormais créer une api rest. Pour la tester vous pouvez utiliser l'extension restclient pour firefox par exemple.

Un exemple plus complexe avec notre modèle

Lister l'ensemble des éléments présents en base
from flask_restful import fields, marshal_with

dinosaur_fields = {
    'name': fields.String,
    'birthday': fields.String,
}

class DinosaursAPI(Resource):
    @marshal_with(dinosaur_fields)
    def get(self):
        return [d for d in Dinosaur.select()]

api.add_resource(DinosaurAPI, '/api/dinosaurs/')
Lister un élément
class DinosaurAPI(Resource):
    def get(self, dinosaur_id):
        return Dinosaur.get(dinosaur_id)

api.add_resource(DinosaurAPI, '/api/dinosaurs/<dinosaur_id>')
Et les CRUD dans tous cela ?

Il va falloir modifier nos classes en ajoutant les méthodes suivantes:

class DinosaurAPI(Resource):

    def delete(self, dinosaur_id):
        pass

    def put(self, dinosaur_id):
        pass


class DinosaursAPI(Resource):

    def post(self):
        pass

En utilisant la documentation de flask-restful pouvez vous implémenter les cruds de l'api Dinosaur ?