Cum se construiește un API JSON cu Python

Specificația API JSON este un mod puternic de a permite comunicarea între client și server. Specifică structura cererilor și răspunsurilor trimise între cele două, utilizând formatul JSON.

Ca format de date, JSON are avantajele de a fi ușor și lizibil. Acest lucru face foarte ușor să lucrați rapid și productiv. Specificația este concepută pentru a minimiza numărul de solicitări și cantitatea de date care trebuie trimise între client și server.

Aici puteți afla cum să creați un API JSON de bază folosind Python și Flask. Apoi, restul articolului vă va arăta cum să încercați unele dintre caracteristicile pe care le poate oferi specificațiile API JSON.

Flask este o bibliotecă Python care oferă un „micro-cadru” pentru dezvoltarea web. Este excelent pentru o dezvoltare rapidă, deoarece vine cu o funcționalitate de bază simplă, dar extensibilă.

Un exemplu cu adevărat de bază despre cum să trimiteți un răspuns de tip JSON folosind Flask este prezentat mai jos:

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

Acest articol va folosi două suplimente pentru Flask:

  • Flask-REST-JSONAPI va ajuta la dezvoltarea unui API care respectă îndeaproape specificațiile API JSON.
  • Flask-SQLAlchemy va folosi SQLAlchemy pentru a face crearea și interacțiunea cu o bază de date simplă foarte simplă.

Imaginea de ansamblu

Scopul final este de a crea un API care să permită interacțiunea client-parte cu o bază de date subiacentă. Vor exista câteva straturi între baza de date și client - un strat de abstractizare a datelor și un strat de manager de resurse.

Iată o prezentare generală a pașilor implicați:

  1. Definiți o bază de date utilizând Flask-SQLAlchemy
  2. Creați o abstractizare a datelor cu Marshmallow-JSONAPI
  3. Creați administratori de resurse cu Flask-REST-JSONAPI
  4. Creați puncte finale URL și porniți serverul cu Flask

Acest exemplu va folosi o schemă simplă care descrie artiști moderni și relațiile lor cu diferite opere de artă.

Instalați totul

Înainte de a începe, va trebui să configurați proiectul. Aceasta implică crearea unui spațiu de lucru și a unui mediu virtual, instalarea modulelor necesare și crearea principalelor fișiere Python și a bazei de date pentru proiect.

Din linia de comandă creați un nou director și navigați în interior.

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

Este o practică bună să creați medii virtuale pentru fiecare proiect Python. Puteți sări peste acest pas, dar este foarte recomandat.

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

Odată ce mediul dvs. virtual a fost creat și activat, puteți instala modulele necesare pentru acest proiect.

$ pip install flask-rest-jsonapi flask-sqlalchemy

Tot ce veți avea nevoie va fi instalat ca cerințe pentru aceste două extensii. Aceasta include Flask în sine și SQLAlchemy.

Următorul pas este să creați un fișier Python și o bază de date pentru proiect.

$ touch application.py artists.db

Creați schema bazei de date

Aici, veți începe modificarea application.pypentru a defini și a crea schema bazei de date pentru proiect.

Deschideți application.pyîn editorul de text preferat. Începeți prin importul unor module. Pentru claritate, modulele vor fi importate pe măsură ce mergeți.

Apoi, creați un obiect numit appca instanță a clasei Flask.

După aceea, utilizați SQLAlchemy pentru a vă conecta la fișierul bazei de date pe care l-ați creat. Etapa finală este definirea și crearea unui tabel numit 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()

Crearea unui strat de abstractizare

Următorul pas folosește modulul Marshmallow-JSONAPI pentru a crea o abstractizare logică a datelor peste tabelele tocmai definite.

Motivul pentru a crea acest strat de abstractizare este simplu. Vă oferă mai mult control asupra modului în care datele dvs. subiacente sunt expuse prin intermediul API-ului. Gândiți-vă la acest strat ca la un obiectiv prin care clientul API poate vizualiza în mod clar datele subiacente și numai biții pe care trebuie să le vadă.

În codul de mai jos, stratul de abstractizare a datelor este definit ca o clasă care moștenește din clasa Marshmallow-JSONAPI Schema. Acesta va oferi acces prin API atât la înregistrări individuale, cât și la înregistrări multiple din tabelul artiștilor.

În interiorul acestui bloc, Metaclasa definește câteva metadate. Mai exact, numele punctului final URL pentru interacțiunea cu înregistrări individuale va fi artist_one, unde fiecare artist va fi identificat printr-un parametru URL . Numele punctului final pentru interacțiunea cu multe înregistrări va fi artist_many.

Restul atributelor definite se referă la coloanele din tabelul artiștilor. Aici puteți controla în continuare modul în care fiecare este expus prin API.

De exemplu, atunci când faceți solicitări POST pentru a adăuga artiști noi la baza de date, vă puteți asigura că namecâmpul este obligatoriu setând required=True.

Și dacă, din orice motiv, nu ați dorit ca birth_yearcâmpul să fie returnat atunci când faceți solicitări GET, puteți specifica acest lucru setând 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() 

Creați administratori de resurse și puncte finale URL

Piesa finală a puzzle-ului este de a crea un manager de resurse și un punct final corespunzător pentru fiecare dintre trasee / artiști și / artiști / id.

Fiecare manager de resurse este definit ca o clasă care moștenește din clasele Flask-REST-JSONAPI ResourceListși ResourceDetail.

Aici iau două atribute. schemaeste utilizat pentru a indica stratul de extragere a datelor pe care îl folosește managerul de resurse și data_layerindică sesiunea și modelul de date care vor fi utilizate pentru stratul de date.

Apoi, definiți apica o instanță a Apiclasei Flask-REST-JSONAPI și creați rutele pentru API cu api.route(). Această metodă ia trei argumente - clasa stratului de abstractizare a datelor, numele punctului final și calea URL.

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!