Comment créer une API JSON avec Python

La spécification de l'API JSON est un moyen puissant pour permettre la communication entre le client et le serveur. Il spécifie la structure des requêtes et réponses envoyées entre les deux, en utilisant le format JSON.

En tant que format de données, JSON présente les avantages d'être léger et lisible. Cela rend très facile de travailler rapidement et de manière productive. La spécification est conçue pour minimiser le nombre de demandes et la quantité de données à envoyer entre le client et le serveur.

Ici, vous pouvez apprendre à créer une API JSON de base à l'aide de Python et Flask. Ensuite, le reste de l'article vous montrera comment essayer certaines des fonctionnalités que la spécification de l'API JSON a à offrir.

Flask est une bibliothèque Python qui fournit un «micro-framework» pour le développement Web. Il est idéal pour un développement rapide car il est livré avec une fonctionnalité de base simple mais extensible.

Un exemple vraiment basique de la façon d'envoyer une réponse de type JSON à l'aide de Flask est présenté ci-dessous:

from flask import Flask app = Flask(__name__) @app.route('/') def example(): return '{"name":"Bob"}' if __name__ == '__main__': app.run()

Cet article utilisera deux modules complémentaires pour Flask:

  • Flask-REST-JSONAPI aidera à développer une API qui suit de près la spécification de l'API JSON.
  • Flask-SQLAlchemy utilisera SQLAlchemy pour rendre la création et l'interaction avec une base de données simple très simple.

La grande image

L'objectif final est de créer une API qui permet une interaction côté client avec une base de données sous-jacente. Il y aura quelques couches entre la base de données et le client - une couche d'abstraction de données et une couche de gestionnaire de ressources.

Voici un aperçu des étapes impliquées:

  1. Définir une base de données à l'aide de Flask-SQLAlchemy
  2. Créer une abstraction de données avec Marshmallow-JSONAPI
  3. Créez des gestionnaires de ressources avec Flask-REST-JSONAPI
  4. Créez des points de terminaison d'URL et démarrez le serveur avec Flask

Cet exemple utilisera un schéma simple décrivant les artistes modernes et leurs relations avec différentes œuvres d'art.

Tout installer

Avant de commencer, vous devez configurer le projet. Cela implique la création d'un espace de travail et d'un environnement virtuel, l'installation des modules requis et la création des principaux fichiers Python et de base de données pour le projet.

À partir de la ligne de commande, créez un nouveau répertoire et naviguez à l'intérieur.

$ mkdir flask-jsonapi-demo $ cd flask-jsonapi-demo/

Il est recommandé de créer des environnements virtuels pour chacun de vos projets Python. Vous pouvez sauter cette étape, mais elle est fortement recommandée.

$ python -m venv .venv $ source .venv/bin/activate 

Une fois votre environnement virtuel créé et activé, vous pouvez installer les modules nécessaires à ce projet.

$ pip install flask-rest-jsonapi flask-sqlalchemy

Tout ce dont vous aurez besoin sera installé selon les exigences de ces deux extensions. Cela inclut Flask lui-même et SQLAlchemy.

L'étape suivante consiste à créer un fichier Python et une base de données pour le projet.

$ touch application.py artists.db

Créer le schéma de base de données

Ici, vous allez commencer à modifier application.pypour définir et créer le schéma de base de données pour le projet.

Ouvrez application.pydans votre éditeur de texte préféré. Commencez par importer certains modules. Pour plus de clarté, les modules seront importés au fur et à mesure.

Ensuite, créez un objet appelé appcomme instance de la classe Flask.

Après cela, utilisez SQLAlchemy pour vous connecter au fichier de base de données que vous avez créé. La dernière étape consiste à définir et créer une table appelée artists.

from flask import Flask from flask_sqlalchemy import SQLAlchemy # Create a new Flask application app = Flask(__name__) # Set up SQLAlchemy app.config['SQLALCHEMY_DATABASE_URI'] = 'sqlite:////artists.db' db = SQLAlchemy(app) # Define a class for the Artist table class Artist(db.Model): id = db.Column(db.Integer, primary_key=True) name = db.Column(db.String) birth_year = db.Column(db.Integer) genre = db.Column(db.String) # Create the table db.create_all()

Créer une couche d'abstraction

L'étape suivante utilise le module Marshmallow-JSONAPI pour créer une abstraction de données logique sur les tables qui viennent d'être définies.

La raison de créer cette couche d'abstraction est simple. Cela vous donne plus de contrôle sur la façon dont vos données sous-jacentes sont exposées via l'API. Considérez cette couche comme une lentille à travers laquelle le client API peut afficher clairement les données sous-jacentes et uniquement les bits dont il a besoin.

Dans le code ci-dessous, la couche d'abstraction de données est définie comme une classe qui hérite de la classe de Marshmallow-JSONAPI Schema. Il donnera accès via l'API à la fois aux enregistrements uniques et aux enregistrements multiples de la table des artistes.

À l'intérieur de ce bloc, la Metaclasse définit certaines métadonnées. Plus précisément, le nom du point de terminaison d'URL pour interagir avec des enregistrements uniques sera artist_one, où chaque artiste sera identifié par un paramètre d'URL . Le nom du point de terminaison pour interagir avec de nombreux enregistrements sera artist_many.

Les autres attributs définis concernent les colonnes de la table des artistes. Ici, vous pouvez contrôler davantage la façon dont chacun est exposé via l'API.

Par exemple, lorsque vous effectuez des requêtes POST pour ajouter de nouveaux artistes à la base de données, vous pouvez vous assurer que le namechamp est obligatoire en définissant required=True.

Et si, pour une raison quelconque, vous ne souhaitez pas que le birth_yearchamp soit renvoyé lors des requêtes GET, vous pouvez le spécifier en définissant load_only=True.

from marshmallow_jsonapi.flask import Schema from marshmallow_jsonapi import fields # Create data abstraction layer class ArtistSchema(Schema): class Meta: type_ = 'artist' self_view = 'artist_one' self_view_kwargs = {'id': ''} self_view_many = 'artist_many' id = fields.Integer() name = fields.Str(required=True) birth_year = fields.Integer(load_only=True) genre = fields.Str() 

Créer des gestionnaires de ressources et des points de terminaison d'URL

The final piece of the puzzle is to create a resource manager and corresponding endpoint for each of the routes /artists and /artists/id.

Each resource manager is defined as a class that inherits from the Flask-REST-JSONAPI classes ResourceList and ResourceDetail.

Here they take two attributes. schema is used to indicate the data abstraction layer the resource manager uses, and data_layer indicates the session and data model that will be used for the data layer.

Next, define api as an instance of Flask-REST-JSONAPI's Api class, and create the routes for the API with api.route(). This method takes three arguments - the data abstraction layer class, the endpoint name, and the URL path.

The last step is to write a main loop to launch the app in debug mode when the script is run directly. Debug mode is great for development, but it is not suitable for running in production.

# Create resource managers and endpoints from flask_rest_jsonapi import Api, ResourceDetail, ResourceList class ArtistMany(ResourceList): schema = ArtistSchema data_layer = {'session': db.session, 'model': Artist} class ArtistOne(ResourceDetail): schema = ArtistSchema data_layer = {'session': db.session, 'model': Artist} api = Api(app) api.route(ArtistMany, 'artist_many', '/artists') api.route(ArtistOne, 'artist_one', '/artists/') # main loop to run app in debug mode if __name__ == '__main__': app.run(debug=True)

Make GET and POST requests

Now you can start using the API to make HTTP requests. This could be from a web browser, or from a command line tool like curl, or from within another program (e.g., a Python script using the Requests library).

To launch the server, run the application.py script with:

$ python application.py

In your browser, navigate to //localhost:5000/artists.  You will see a JSON output of all the records in the database so far. Except, there are none.

To start adding records to the database, you can make a POST request. One way of doing this is from the command line using curl. Alternatively, you could use a tool like Insomnia, or perhaps code up a simple HTML user interface that posts data using a form.

With curl, from the command line:

curl -i -X POST -H 'Content-Type: application/json' -d '{"data":{"type":"artist", "attributes":{"name":"Salvador Dali", "birth_year":1904, "genre":"Surrealism"}}}' //localhost:5000/artists

Now if you navigate to //localhost:5000/artists, you will see the record you just added. If you were to add more records, they would all show here as well, as this URL path calls the artists_many endpoint.

To view just a single artist by their id number, you can navigate to the relevant URL. For example, to see the first artist, try //localhost:5000/artists/1.

Filtering and sorting

One of the neat features of the JSON API specification is the ability to return the response in more useful ways by defining some parameters in the URL. For instance, you can sort the results according to a chosen field, or filter based on some criteria.

Flask-REST-JSONAPI comes with this built in.

To sort artists in order of birth year, just navigate to //localhost:5000/artists?sort=birth_year. In a web application, this would save you from needing to sort results on the client side, which could be costly in terms of performance and therefore impact the user experience.

Filtering is also easy. You append to the URL the criteria you wish to filter on, contained in square brackets. There are three pieces of information to include:

  • "name" - the field you are filtering by (e.g., birth_year)
  • "op" - the filter operation ("equal to", "greater than", "less than" etc.)
  • "val" - the value to filter against (e.g., 1900)

For example, the URL below retrieves artists whose birth year is greater than 1900:

//localhost:5000/artists?filter=[{"name":"birth_year","op":"gt","val":1900}]

This functionality makes it much easier to retrieve only relevant information when calling the API. This is valuable for improving performance, especially when retrieving potentially large volumes of data over a slow connection.

Pagination

Another feature of the JSON API specification that aids performance is pagination. This is when large responses are sent over several "pages", rather than all in one go. You can control the page size and the number of the page you request in the URL.

So, for example, you could receive 100 results over 10 pages instead of loading all 100 in one go. The first page would contain results 1-10, the second page would contain results 11-20, and so on.

To specify the number of results you want to receive per page, you can add the parameter ?page[size]=X to the URL, where X is the number of results. Flask-REST-JSONAPI uses 30 as the default page size.

To request a given page number, you can add the parameter ?page[number]=X, where is the page number. You can combine both parameters as shown below:

//localhost:5000/artists?page[size]=2&page[number]=2

This URL sets the page size to two results per page, and asks for the second page of results. This would return the third and fourth results from the overall response.

Relationships

Almost always, data in one table will be related to data stored in another. For instance, if you have a table of artists, chances are you might also want a table of artworks. Each artwork is related to the artist who created it.

The JSON API specification allows you to work with relational data easily, and the Flask-REST-JSONAPI lets you take advantage of this. Here, this will be demonstrated by adding an artworks table to the database, and including relationships between artist and artwork.

To implement the artworks example, it will be necessary to make a few changes to the code in application.py.

First, make a couple of extra imports, then create a new table which relates each artwork to an artist:

from marshmallow_jsonapi.flask import Relationship from flask_rest_jsonapi import ResourceRelationship # Define the Artwork table class Artwork(db.Model): id = db.Column(db.Integer, primary_key=True) title = db.Column(db.String) artist_id = db.Column(db.Integer, db.ForeignKey('artist.id')) artist = db.relationship('Artist', backref=db.backref('artworks'))

Next, rewrite the abstraction layer:

# Create data abstraction class ArtistSchema(Schema): class Meta: type_ = 'artist' self_view = 'artist_one' self_view_kwargs = {'id': ''} self_view_many = 'artist_many' id = fields.Integer() name = fields.Str(required=True) birth_year = fields.Integer(load_only=True) genre = fields.Str() artworks = Relationship(self_view = 'artist_artworks', self_view_kwargs = {'id': ''}, related_view = 'artwork_many', many = True, schema = 'ArtworkSchema', type_ = 'artwork') class ArtworkSchema(Schema): class Meta: type_ = 'artwork' self_view = 'artwork_one' self_view_kwargs = {'id': ''} self_view_many = 'artwork_many' id = fields.Integer() title = fields.Str(required=True) artist_id = fields.Integer(required=True) 

This defines an abstraction layer for the artwork table, and adds a relationship between artist and artwork to the ArtistSchema class.

Next, define new resource managers for accessing artworks many at once and one at a time, and also for accessing the relationships between artist and artwork.

class ArtworkMany(ResourceList): schema = ArtworkSchema data_layer = {'session': db.session, 'model': Artwork} class ArtworkOne(ResourceDetail): schema = ArtworkSchema data_layer = {'session': db.session, 'model': Artwork} class ArtistArtwork(ResourceRelationship): schema = ArtistSchema data_layer = {'session': db.session, 'model': Artist}

Finally, add some new endpoints:

api.route(ArtworkOne, 'artwork_one', '/artworks/') api.route(ArtworkMany, 'artwork_many', '/artworks') api.route(ArtistArtwork, 'artist_artworks', '/artists//relationships/artworks')

Run application.py and trying posting some data from the command line via curl:

curl -i -X POST -H 'Content-Type: application/json' -d '{"data":{"type":"artwork", "attributes":{"title":"The Persistance of Memory", "artist_id":1}}}' //localhost:5000/artworks

This will create an artwork related to the artist with id=1.

In the browser, navigate to //localhost:5000/artists/1/relationships/artworks. This should show the artworks related to the artist with id=1. This saves you from writing a more complex URL with parameters to filter artworks by their artist_id field. You can quickly list all the relationships between a given artist and their artworks.

Another feature is the ability to include related results in the response to calling the artists_one endpoint:

//localhost:5000/artists/1?include=artworks

This will return the usual response for the artists endpoint, and also results for each of that artist's artworks.

Sparse Fields

One last feature worth mentioning - sparse fields. When working with large data resources with many complex relationships, the response sizes can blow up real fast. It is helpful to only retrieve the fields you are interested in.

The JSON API specification lets you do this by adding a fields parameter to the URL. For example URL below gets the response for a given artist and their related artworks. However, instead of returning all the fields for the given artwork, it returns only the title.

//localhost:5000/artists/1?include=artworks&fields[artwork]=title

This is again very helpful for improving performance, especially over slow connections. As a general rule, you should only make requests to and from the server with the minimal amount of data required.

Final remarks

The JSON API specification is a very useful framework for sending data between server and client in a clean, flexible format. This article has provided an overview of what you can do with it, with a worked example in Python using the Flask-REST-JSONAPI library.

So what will you do next? There are many possibilities. The example in this article has been a simple proof-of-concept, with just two tables and a single relationship between them. You can develop an application as sophisticated as you like, and create a powerful API to interact with it using all the tools provided here.

Thanks for reading, and keep coding in Python!