Ako zostaviť JSON API s Pythonom

Špecifikácia JSON API je výkonný spôsob umožňujúci komunikáciu medzi klientom a serverom. Určuje štruktúru žiadostí a odpovedí odosielaných medzi týmito dvoma servermi pomocou formátu JSON.

Ako dátový formát má JSON výhody v tom, že je ľahký a čitateľný. Vďaka tomu je veľmi ľahké pracovať rýchlo a produktívne. Špecifikácia je navrhnutá tak, aby minimalizovala počet požiadaviek a množstvo údajov, ktoré je potrebné odoslať medzi klientom a serverom.

Tu sa dozviete, ako vytvoriť základné rozhranie JSON API pomocou jazykov Python a Flask. Zvyšok článku vám potom ukáže, ako vyskúšať niektoré z funkcií, ktoré ponúka špecifikácia JSON API.

Flask je knižnica Pythonu, ktorá poskytuje „mikro-rámec“ pre vývoj webových aplikácií. Je vynikajúci pre rýchly vývoj, pretože prichádza s jednoduchou, ale zároveň rozšíriteľnou funkciou jadra.

Skutočne základný príklad toho, ako poslať odpoveď podobnú JSON pomocou banky, je uvedený nižšie:

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

V tomto článku budú použité dva doplnky pre banku:

  • Flask-REST-JSONAPI pomôže vyvinúť API, ktoré dôsledne dodržiava špecifikáciu JSON API.
  • Flask-SQLAlchemy použije SQLAlchemy na veľmi jednoduché vytváranie a interakciu s jednoduchou databázou.

Veľký obrázok

Konečným cieľom je vytvoriť API, ktoré umožňuje interakciu na strane klienta s podkladovou databázou. Medzi databázou a klientom bude niekoľko vrstiev - vrstva abstrakcie údajov a vrstva správcu zdrojov.

Tu je prehľad príslušných krokov:

  1. Definujte databázu pomocou Flask-SQLAlchemy
  2. Vytvorte abstrakciu údajov pomocou nástroja Marshmallow-JSONAPI
  3. Vytvorte správcov zdrojov pomocou Flask-REST-JSONAPI
  4. Vytvorte koncové body adresy URL a server spustite pomocou banky

Tento príklad použije jednoduchú schému popisujúcu moderných umelcov a ich vzťahy k rôznym umeleckým dielam.

Nainštalujte všetko

Predtým, ako začnete, musíte nastaviť projekt. To zahŕňa vytvorenie pracovného priestoru a virtuálneho prostredia, inštaláciu požadovaných modulov a vytvorenie hlavných súborov Pythonu a databázy pre projekt.

Z príkazového riadku vytvorte nový adresár a prejdite dovnútra.

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

Je dobrým zvykom vytvárať virtuálne prostredia pre každý z vašich projektov v jazyku Python. Tento krok môžete preskočiť, ale dôrazne sa to odporúča.

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

Po vytvorení a aktivácii vášho virtuálneho prostredia môžete nainštalovať moduly potrebné pre tento projekt.

$ pip install flask-rest-jsonapi flask-sqlalchemy

Nainštaluje sa všetko, čo budete potrebovať ako požiadavky na tieto dve rozšírenia. Patrí sem Flask samotný a SQLAlchemy.

Ďalším krokom je vytvorenie súboru a databázy Python pre projekt.

$ touch application.py artists.db

Vytvorte databázovú schému

Tu začnete upravovať, application.pyaby ste definovali a vytvorili databázovú schému pre projekt.

Otvorte application.pyv preferovanom textovom editore. Začnite importom niektorých modulov. Kvôli prehľadnosti sa moduly budú importovať tak, ako idete.

Ďalej vytvorte objekt nazývaný appako inštancia triedy Flask.

Potom sa pomocou nástroja SQLAlchemy pripojte k vytvorenému databázovému súboru. Posledným krokom je definovanie a vytvorenie tabuľky s názvom 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()

Vytvorenie abstrakčnej vrstvy

V ďalšom kroku sa pomocou modulu Marshmallow-JSONAPI vytvorí logická abstrakcia údajov nad práve definovanými tabuľkami.

Dôvod na vytvorenie tejto abstrakčnej vrstvy je jednoduchý. Poskytuje vám väčšiu kontrolu nad tým, ako sú vaše základné údaje vystavené prostredníctvom rozhrania API. Predstavte si túto vrstvu ako šošovku, cez ktorú môže klient API jasne vidieť základné údaje a iba tie bity, ktoré potrebuje vidieť.

V nižšie uvedenom kóde je vrstva abstrakcie údajov definovaná ako trieda, ktorá dedí z triedy Marshmallow-JSONAPI Schema. Poskytne prístup cez API k jednotlivým záznamom aj k viacerým záznamom z tabuľky interpretov.

V tomto bloku Metatrieda definuje niektoré metaúdaje. Konkrétne bude mať názov koncového bodu adresy URL pre interakciu s jednotlivými záznamami artist_one, kde bude každý interpret identifikovaný parametrom adresy URL . Názov koncového bodu pre interakciu s mnohými záznamami bude artist_many.

Zvyšné definované atribúty sa týkajú stĺpcov v tabuľke interpretov. Tu môžete prostredníctvom rozhrania API ďalej ovládať, ako je každá z nich vystavená.

Napríklad pri zadávaní POST požiadaviek na pridanie nových interpretov do databázy sa môžete uistiť, že je namepole povinné, a to nastavením required=True.

A ak ste z akýchkoľvek dôvodov nechceli, aby sa birth_yearpole vracalo pri zadávaní požiadaviek GET, môžete to určiť nastavením 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() 

Vytvorte správcov zdrojov a koncové body adries URL

Poslednou časťou skladačky je vytvorenie správcu zdrojov a zodpovedajúceho koncového bodu pre každú z trás / umelcov a / umelcov / id.

Každý správca prostriedkov je definovaný ako trieda, ktorá dedí z tried Flask-REST-JSONAPI ResourceLista ResourceDetail.

Tu berú dva atribúty. schemasa používa na označenie dátovej abstrakčnej vrstvy, ktorú používa správca zdrojov, a data_layeroznačuje reláciu a dátový model, ktoré sa použijú pre dátovú vrstvu.

Ďalej definujte apiako inštanciu triedy Flask-REST-JSONAPI Apia vytvorte trasy pre API pomocou api.route(). Táto metóda vyžaduje tri argumenty - triedu vrstvy abstrakcie údajov, názov koncového bodu a cestu 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

Špecifikácia API JSON je veľmi užitočný rámec na odosielanie údajov medzi serverom a klientom v čistom a flexibilnom formáte. Tento článok priniesol prehľad toho, čo s ním môžete robiť, spolu s vypracovaným príkladom v Pythone pomocou knižnice Flask-REST-JSONAPI.

Čo teda budete robiť ďalej? Možností je veľa. Príkladom v tomto článku bol jednoduchý dôkaz o koncepcii, ktorý má iba dve tabuľky a jediný vzťah medzi nimi. Aplikáciu môžete vyvinúť tak sofistikovane, ako sa vám páči, a vytvoriť výkonné rozhranie API na interakciu s ňou pomocou všetkých tu uvedených nástrojov.

Ďakujeme za prečítanie a naďalej programujte v Pythone!