Documentation ·وثائق
إرشادات تصميم الواجهات

الإيقاف

كيف تعلن العملية عن إيقافها: deprecated true، وترويستا Deprecation وSunset على كل استجابة نجاح، وإشارة إلى البديل.

اقرأ هذه الصفحة بـ English

في هذه الصفحة

نظرة سريعة#

يعرف العميل أن العملية في طريقها إلى الزوال من التعريف ومن الاستجابة نفسها. يعلّم التعريف العملية بـ deprecated: true؛ وتوثّق كل استجابة نجاح لتلك العملية ترويستين.

الترويسةالمعيارالقيمةمثال
DeprecationRFC 9745لحظة إيقاف العملية، كطابع زمني Unix تسبقه @Deprecation: @1792368000
SunsetRFC 8594لحظة توقف العملية عن الإجابة، كتاريخ HTTPSunset: Tue, 19 Jan 2027 00:00:00 GMT
LinkRFC 8288اختيارية: البديل، مع rel="successor-version"Link: </v3/orders>; rel="successor-version"
HTTP/1.1 200 OK
Deprecation: @1792368000
Sunset: Tue, 19 Jan 2027 00:00:00 GMT
Link: </v3/orders>; rel="successor-version"
Content-Type: application/json

في التعريف#

/orders/legacy:
  get:
    operationId: legacyOrders
    deprecated: true
    description: Replaced by the orders list of v3.
    responses:
      "200":
        description: Orders.
        headers:
          Deprecation:
            description: When this operation was deprecated.
            schema: { type: string }
          Sunset:
            description: When this operation stops answering.
            schema: { type: string }

اذكر في description ما يحلّ محل العملية. ولا تسبق لحظة Sunset أبداً نهاية مدة الإشعار في قواعد الإصدارات.

مخطّط له

تضيف البوابة ترويستي Deprecation وSunset إلى كل استجابة من إصدار رئيسي موقوف، وتبقى المسارات قائمة حتى تاريخ الإيقاف النهائي.

تتحقق منه#

القاعدةالشدةما تتحقق منه
api360-deprecation-headerserrorتُوثّق العملية ذات deprecated: true الترويستين Deprecation وSunset على كل استجابة 2xx (أسماء الترويسات غير حساسة لحالة الأحرف)

انظر أيضاً#

هل كانت هذه الصفحة مفيدة؟
آخر تحديث 2026-10-17