Jak zbudować API JSON w Pythonie

Specyfikacja JSON API to potężny sposób na umożliwienie komunikacji między klientem a serwerem. Określa strukturę żądań i odpowiedzi przesyłanych między nimi przy użyciu formatu JSON.

JSON jako format danych ma tę zaletę, że jest lekki i czytelny. Dzięki temu bardzo łatwo jest pracować z nim szybko i wydajnie. Specyfikacja ma na celu zminimalizowanie liczby żądań i ilości danych, które wymagają przesłania między klientem a serwerem.

Tutaj możesz dowiedzieć się, jak utworzyć podstawowy interfejs API JSON przy użyciu języków Python i Flask. W dalszej części artykułu dowiesz się, jak wypróbować niektóre funkcje, które ma do zaoferowania specyfikacja JSON API.

Flask to biblioteka Pythona, która zapewnia „mikro-framework” do tworzenia stron internetowych. Jest świetny do szybkiego rozwoju, ponieważ ma prostą, ale rozszerzalną podstawową funkcjonalność.

Naprawdę podstawowy przykład wysyłania odpowiedzi podobnej do JSON przy użyciu Flask jest pokazany poniżej:

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

W tym artykule będą używane dwa dodatki do Flask:

  • Flask-REST-JSONAPI pomoże opracować API, które jest ściśle zgodne ze specyfikacją JSON API.
  • Flask-SQLAlchemy użyje SQLAlchemy do bardzo prostego tworzenia i interakcji z prostą bazą danych.

Wielkie zdjęcie

Ostatecznym celem jest stworzenie interfejsu API, który umożliwia interakcję po stronie klienta z bazową bazą danych. Pomiędzy bazą danych a klientem będzie kilka warstw - warstwa abstrakcji danych i warstwa zarządzania zasobami.

Oto przegląd wymaganych kroków:

  1. Zdefiniuj bazę danych za pomocą Flask-SQLAlchemy
  2. Utwórz abstrakcję danych za pomocą Marshmallow-JSONAPI
  3. Twórz menedżery zasobów za pomocą Flask-REST-JSONAPI
  4. Utwórz punkty końcowe adresu URL i uruchom serwer z Flask

W tym przykładzie posłużymy się prostym schematem opisującym współczesnych artystów i ich związki z różnymi dziełami sztuki.

Zainstaluj wszystko

Zanim zaczniesz, musisz skonfigurować projekt. Obejmuje to utworzenie obszaru roboczego i środowiska wirtualnego, zainstalowanie wymaganych modułów oraz utworzenie głównego języka Python i plików bazy danych dla projektu.

Z wiersza poleceń utwórz nowy katalog i przejdź do niego.

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

Dobrą praktyką jest tworzenie środowisk wirtualnych dla każdego projektu w języku Python. Możesz pominąć ten krok, ale jest to zdecydowanie zalecane.

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

Po utworzeniu i aktywowaniu środowiska wirtualnego możesz zainstalować moduły potrzebne do tego projektu.

$ pip install flask-rest-jsonapi flask-sqlalchemy

Wszystko, czego będziesz potrzebować, zostanie zainstalowane jako wymagania dla tych dwóch rozszerzeń. Obejmuje to samą Flask i SQLAlchemy.

Następnym krokiem jest utworzenie pliku Python i bazy danych dla projektu.

$ touch application.py artists.db

Utwórz schemat bazy danych

Tutaj zaczniesz modyfikować, application.pyaby zdefiniować i utworzyć schemat bazy danych dla projektu.

Otwórz application.pyw preferowanym edytorze tekstu. Zacznij od zaimportowania niektórych modułów. Dla jasności moduły będą importowane na bieżąco.

Następnie utwórz obiekt nazywany appinstancją klasy Flask.

Następnie użyj SQLAlchemy, aby połączyć się z utworzonym plikiem bazy danych. Ostatnim krokiem jest zdefiniowanie i utworzenie tabeli o nazwie 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()

Tworzenie warstwy abstrakcji

W następnym kroku używany jest moduł Marshmallow-JSONAPI do utworzenia logicznej abstrakcji danych dla właśnie zdefiniowanych tabel.

Powód stworzenia tej warstwy abstrakcji jest prosty. Zapewnia większą kontrolę nad sposobem ujawniania danych bazowych za pośrednictwem interfejsu API. Pomyśl o tej warstwie jako soczewce, przez którą klient API może wyraźnie zobaczyć podstawowe dane i tylko te bity, które muszą zobaczyć.

W poniższym kodzie warstwa abstrakcji danych jest zdefiniowana jako klasa dziedzicząca po klasie Marshmallow-JSONAPI Schema. Zapewni dostęp za pośrednictwem interfejsu API zarówno do pojedynczych rekordów, jak i wielu rekordów z tabeli artystów.

W tym bloku Metaklasa definiuje niektóre metadane. W szczególności nazwa punktu końcowego adresu URL służącego do interakcji z pojedynczymi rekordami to artist_one, gdzie każdy artysta będzie identyfikowany za pomocą parametru adresu URL . Nazwą punktu końcowego do interakcji z wieloma rekordami będzie artist_many.

Pozostałe zdefiniowane atrybuty odnoszą się do kolumn w tabeli artystów. Tutaj możesz dalej kontrolować sposób ujawniania każdego z nich za pośrednictwem interfejsu API.

Na przykład, wykonując żądania POST, aby dodać nowych artystów do bazy danych, możesz upewnić się, że namepole jest obowiązkowe, ustawiając required=True.

A jeśli z jakiegoś powodu nie chcesz, aby birth_yearpole było zwracane podczas wykonywania żądań GET, możesz to określić, ustawiając 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() 

Utwórz menedżerów zasobów i punkty końcowe adresów 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!