كيفية إنشاء JSON API باستخدام Python

تعد مواصفات واجهة برمجة تطبيقات JSON طريقة فعالة لتمكين الاتصال بين العميل والخادم. يحدد هيكل الطلبات والاستجابات المرسلة بينهما ، باستخدام تنسيق JSON.

كتنسيق بيانات ، تتمتع JSON بمزايا كونها خفيفة الوزن وقابلة للقراءة. هذا يجعل من السهل جدًا العمل معها بسرعة وإنتاجية. تم تصميم المواصفات لتقليل عدد الطلبات وكمية البيانات التي تحتاج إلى إرسال بين العميل والخادم.

هنا ، يمكنك تعلم كيفية إنشاء واجهة برمجة تطبيقات JSON أساسية باستخدام Python و Flask. بعد ذلك ، ستوضح لك بقية المقالة كيفية تجربة بعض الميزات التي يجب أن توفرها مواصفات JSON API.

Flask هي مكتبة Python توفر "إطار عمل صغير" لتطوير الويب. إنه أمر رائع للتطوير السريع لأنه يأتي بوظيفة أساسية بسيطة ولكنها قابلة للتوسيع.

يظهر أدناه مثال أساسي حقًا لكيفية إرسال استجابة تشبه JSON باستخدام Flask:

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

ستستخدم هذه المقالة إضافتين لـ Flask:

  • سيساعد Flask-REST-JSONAPI في تطوير واجهة برمجة تطبيقات تتبع مواصفات JSON API عن كثب.
  • سيستخدم Flask-SQLAlchemy SQLAlchemy لجعل إنشاء قاعدة بيانات بسيطة والتفاعل معها أمرًا سهلاً للغاية.

الصورة الكبيرة

الهدف النهائي هو إنشاء واجهة برمجة تطبيقات تسمح بالتفاعل من جانب العميل مع قاعدة بيانات أساسية. سيكون هناك طبقتان بين قاعدة البيانات والعميل - طبقة تجريد البيانات وطبقة مدير الموارد.

فيما يلي نظرة عامة على الخطوات المتبعة:

  1. حدد قاعدة بيانات باستخدام Flask-SQLAlchemy
  2. إنشاء تجريد البيانات باستخدام Marshmallow-JSONAPI
  3. قم بإنشاء مديري الموارد باستخدام Flask-REST-JSONAPI
  4. قم بإنشاء نقاط نهاية URL وابدأ الخادم باستخدام Flask

سيستخدم هذا المثال مخططًا بسيطًا يصف الفنانين المعاصرين وعلاقاتهم بالأعمال الفنية المختلفة.

تثبيت كل شيء

قبل البدء ، ستحتاج إلى إعداد المشروع. يتضمن ذلك إنشاء مساحة عمل وبيئة افتراضية ، وتثبيت الوحدات النمطية المطلوبة ، وإنشاء ملفات Python وقاعدة البيانات الرئيسية للمشروع.

من سطر الأوامر ، أنشئ دليلًا جديدًا وانتقل إلى الداخل.

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

من الممارسات الجيدة إنشاء بيئات افتراضية لكل مشروع من مشاريع Python الخاصة بك. يمكنك تخطي هذه الخطوة ، لكن يوصى بها بشدة.

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

بمجرد إنشاء بيئتك الافتراضية وتنشيطها ، يمكنك تثبيت الوحدات المطلوبة لهذا المشروع.

$ pip install flask-rest-jsonapi flask-sqlalchemy

سيتم تثبيت كل ما تحتاجه حسب متطلبات هذين الملحقين. يتضمن هذا Flask نفسه و SQLAlchemy.

الخطوة التالية هي إنشاء ملف Python وقاعدة بيانات للمشروع.

$ touch application.py artists.db

قم بإنشاء مخطط قاعدة البيانات

هنا ، ستبدأ في التعديل application.pyلتعريف وإنشاء مخطط قاعدة البيانات للمشروع.

افتح application.pyفي محرر النصوص المفضل لديك. ابدأ باستيراد بعض الوحدات. للتوضيح ، سيتم استيراد الوحدات النمطية كما تذهب.

بعد ذلك ، قم بإنشاء كائن يسمى appكمثيل لفئة Flask.

بعد ذلك ، استخدم SQLAlchemy للاتصال بملف قاعدة البيانات الذي أنشأته. الخطوة الأخيرة هي تحديد وإنشاء جدول يسمى 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()

إنشاء طبقة تجريدية

تستخدم الخطوة التالية وحدة Marshmallow-JSONAPI لإنشاء تجريد منطقي للبيانات عبر الجداول التي تم تعريفها للتو.

سبب إنشاء طبقة التجريد هذه بسيط. يمنحك مزيدًا من التحكم في كيفية عرض بياناتك الأساسية عبر واجهة برمجة التطبيقات. فكر في هذه الطبقة كعدسة يمكن لعميل واجهة برمجة التطبيقات من خلالها عرض البيانات الأساسية بوضوح ، والبتات التي يحتاجون إلى رؤيتها فقط.

في الكود أدناه ، تُعرَّف طبقة تجريد البيانات بأنها فئة ترث من فئة Marshmallow-JSONAPI Schema. سيوفر الوصول عبر API إلى كل من السجلات الفردية والسجلات المتعددة من جدول الفنانين.

داخل هذه الكتلة ، Metaيحدد الفصل بعض البيانات الوصفية. على وجه التحديد ، سيكون اسم نقطة نهاية عنوان URL للتفاعل مع السجلات الفردية artist_one، حيث سيتم تحديد كل فنان بواسطة معلمة URL . سيكون اسم نقطة النهاية للتفاعل مع العديد من السجلات artist_many.

السمات المتبقية المحددة تتعلق بالأعمدة في جدول الفنانين. هنا ، يمكنك التحكم بشكل أكبر في كيفية تعرض كل منها عبر واجهة برمجة التطبيقات.

على سبيل المثال ، عند إجراء طلبات POST لإضافة فنانين جدد إلى قاعدة البيانات ، يمكنك التأكد من أن nameالحقل إلزامي من خلال الإعداد required=True.

وإذا كنت لا تريد birth_yearإرجاع الحقل لأي سبب من الأسباب عند إجراء طلبات GET ، فيمكنك تحديد ذلك عن طريق الإعداد 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() 

إنشاء مديري الموارد ونقاط نهاية URL

الجزء الأخير من اللغز هو إنشاء مدير موارد ونقطة نهاية مقابلة لكل من المسارات / الفنانين و / الفنانين / معرف.

يتم تعريف كل مدير موارد على أنه فئة ترث من فئات Flask-REST-JSONAPI ResourceListو ResourceDetail.

هنا يأخذون سمتين. schemaيستخدم للإشارة إلى طبقة تجريد البيانات التي يستخدمها مدير الموارد ، data_layerويشير إلى الجلسة ونموذج البيانات الذي سيتم استخدامه لطبقة البيانات.

بعد ذلك ، حدد apiكمثيل Apiلفئة Flask-REST-JSONAPI ، وأنشئ المسارات لواجهة برمجة التطبيقات باستخدام api.route(). تأخذ هذه الطريقة ثلاث وسيطات - فئة طبقة تجريد البيانات واسم نقطة النهاية ومسار عنوان 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

تعد مواصفات واجهة برمجة تطبيقات JSON إطارًا مفيدًا للغاية لإرسال البيانات بين الخادم والعميل بتنسيق نظيف ومرن. قدمت هذه المقالة نظرة عامة على ما يمكنك فعله بها ، مع مثال عملي في Python باستخدام مكتبة Flask-REST-JSONAPI.

إذن ماذا ستفعل بعد ذلك؟ هناك احتمالات كثيرة. كان المثال في هذه المقالة إثباتًا بسيطًا للمفهوم ، مع جدولين فقط وعلاقة واحدة بينهما. يمكنك تطوير تطبيق معقد كما تريد ، وإنشاء واجهة برمجة تطبيقات قوية للتفاعل معه باستخدام جميع الأدوات المتوفرة هنا.

شكرًا على القراءة ، واستمر في البرمجة بلغة Python!