apistar
1.0.0
؟ مجموعة أدوات واجهة برمجة تطبيقات الويب. ؟
المجتمع: https://discuss.apistar.org؟ ؟ ؟ ؟
التوثيق: https://docs.apistar.com
المتطلبات: بايثون 3.6+
API Star عبارة عن مجموعة أدوات للعمل مع مخططات OpenAPI أو Swagger. انها تسمح لك:
يمكنك استخدامه لإنشاء وثائق ثابتة أو دمجها في إطار عمل ويب أو استخدامها كمكتبة عميل للتفاعل مع واجهات برمجة التطبيقات الأخرى.
تثبيت API Star:
$ pip3 install apistarدعونا نلقي نظرة على بعض الوظائف التي توفرها مجموعة الأدوات...
سنبدأ بإنشاء مخطط OpenAPI، schema.yaml :
openapi : 3.0.0
info :
title : Widget API
version : ' 1.0 '
description : An example API for widgets
servers :
- url : https://www.example.org/
paths :
/widgets :
get :
summary : List all the widgets.
operationId : listWidgets
parameters :
- in : query
name : search
description : Filter widgets by this search term.
schema :
type : string لنقم أيضًا بإنشاء ملف التكوين apistar.yml :
schema :
path : schema.yaml
format : openapi نحن الآن جاهزون لبدء استخدام أداة سطر الأوامر apistar .
يمكننا التحقق من صحة مخطط OpenAPI الخاص بنا:
$ apistar validate
✓ Valid OpenAPI schema.
أو أنشئ وثائق المطورين لواجهة برمجة التطبيقات (API) الخاصة بنا:
$ apistar docs --serve
✓ Documentation available at "http://127.0.0.1:8000/" (Ctrl+C to quit)
يمكننا أيضًا تقديم طلبات API إلى الخادم المشار إليه في المخطط:
$ apistar request listWidgets search=cogwheel
مع الإصدار 0.6 وما بعده، تم التركيز على مشروع API Star باعتباره مجموعة أدوات واجهة برمجة التطبيقات (API) غير محددة الإطار. وتتمثل الخطة في بناء هذه الوظيفة بطريقة تجعلها مناسبة للاستخدام إما كأداة قائمة بذاتها، أو مع مجموعة كبيرة من أطر العمل.
يظل الفرع 0.5 متاحًا على GitHub، ويمكن تثبيته من PyPI باستخدام pip install apistar==0.5.41 . من المحتمل أن يكون أي تطوير إضافي لخادم API Star يتعارض مع شوكة ذلك، تحت إشراف مشرف جديد.
إذا كنت تبحث عن إطار عمل غير متزامن عالي الأداء يعتمد على Python، فإنني أوصي بدلاً من ذلك بـ Starlette.
API Star هو كود مرخص من BSD.
تم تصميمه وبنائه في برايتون، إنجلترا.
