الوثائق·OpenAPI و Postman
⚙

OpenAPI و Postman

مواصفات OpenAPI حية، عارض Scalar، مجموعة Postman — أنشئ عملاء، خوادم mock، وأي شيء آخر.

مواصفات OpenAPI

تُقدَّم مواصفات OpenAPI 3.1 الرسمية حياً على:

https://api.eveses.com/docs/openapi.yaml

يُعاد إنشاؤها عند كل نشر من معالجات المسارات الفعلية، فلا تنحرف أبداً عن سلوك الإنتاج. استخدمها لـ:

  • إنشاء عملاء بأي لغة (openapi-generator-cli generate -i openapi.yaml -g python)
  • تشغيل خادم mock (prism mock openapi.yaml)
  • مقارنة (diff) مع آخر نسخة vendored في CI

تصفّح

عارض Scalar يعرض المواصفات كمستندات تفاعلية على:

https://api.eveses.com/docs

جرّب نقاط النهاية مباشرة في المتصفح بلصق مفتاح API في صندوق المصادقة.

Postman

استورد المجموعة (المُولَّدة من نفس المواصفات):

https://api.eveses.com/docs/eveses.postman_collection.json

تأتي بمتغيرات البيئة eveses_api_key و eveses_base_url. اضبطها مرة واحدة وتُعبّأ جميع الطلبات مسبقاً.

الإصدارات

المواصفات الحالية هي v1. لا نكسر نقاط نهاية v1 أبداً — الإضافات متوافقة مع الإصدارات السابقة. ستعيش v2 المستقبلية جنباً إلى جنب مع v1 لمدة لا تقل عن 12 شهراً قبل التخلي عن v1.

اشترك في /changelog/api ليتم إعلامك بالإضافات.