Api-blueprint: تعذر الإشارة إلى كائن بنية البيانات داخل المصفوفة

تم إنشاؤها على ٨ مايو ٢٠١٥  ·  6تعليقات  ·  مصدر: apiaryio/api-blueprint

مرحبًا ، شكرًا لمثل هذا المنتج الرائع!

أقوم بتوثيق باستخدام تنسيق JSONAPI ، وأواجه مشكلة في التعبير عن كائن داخل مصفوفة. هذا مطلوب بسبب مواصفات JSONAPI للعلاقات غير الفارغة إلى كثير.

هذا هو مثال الكود الخاص بي:

# Group Stock
All inventory information and management is exposed through the `stock` endpoint.

## Stock [/stock/{id}]

- Parameters
    - id: 1 (number, required) - Specific `id` of a stock item

- Attributes (Stock Base)
    - id: 1 (number) - Specific id of a stock item
    - type: stock (string) - Resource type

### Retireve Stock [GET]
Fetch details about specific stock.

- Response 200 (application/vnd.api+json)
    - Attributes (Stock)

## Stocks [/stock]

- Attributes
    - data(array[Stock]) - Full output of all data

### List all Stock [GET]
Return details of all stock.

- Response 200 (application/vnd.api+json)
    - Attributes (Stocks)

# Data Structures

## Stock Base (object)
- price: 4.50 (number) - Standard price
- sale_price: 3.00 (number) - Specific sale only price
- description: Coconut yoghurt (string) - Text description of stock item
- ingredients: Coconut, Nuts, Milk (string) - Comma separated list of all ingredients
- allergens: Nuts, dairy (string) - Comma separated list of all allergen information
- Include Stock Links Base

## Stock Links Base (object)
- links (object) - JSON API links section
    - *dietary_requirements* (array)
        - Include Linkage
    - *stock_type*
        - Include Linkage

## Linkage (object)
- linkage (object) - JSON API linkage section
    - id: 1 (number)
    - type: reference_type (string)

إذا عرضت هذا في المنحل ، فستلاحظ أن المصفوفة dietary_requirements فارغة ، على الرغم من أنها تشير إلى بنية البيانات Linkage .

screen shot 2015-05-08 at 22 03 23

أي مساعدة سيكون محل تقدير كبير.

Question

التعليق الأكثر فائدة

@ pete001 أيضًا يمكنك تحديد أي نوع كمحتوى مصفوفة مثل:

- my_array (array)
    - (type1)
    - (type2)
    - (another type)

ال 6 كومينتر

حاول تغيير هذا:

- *dietary_requirements* (array)
    - Include Linkage

الى هذا:

- *dietary_requirements* (array[Linkage])

screen shot 2015-05-08 at 22 08 05

لا أعتقد أنه من الممكن استخدام mixins ( include ) مع المصفوفات كما في هذا المثال.

واو ، مذهل تمامًا! شكرًا جزيلاً على الاستجابة السريعة ، لقد نجح هذا بشكل مثالي: ابتسم:

kylef صحيح - Include مخصص للعمل مع الكائنات فقط ( المواصفات ).

لكن المحلل اللغوي يجب أن يحذر في هذه المناسبة - أليس هذا هو الحال؟ // سي سي pksunkara

@ pete001 أيضًا يمكنك تحديد أي نوع كمحتوى مصفوفة مثل:

- my_array (array)
    - (type1)
    - (type2)
    - (another type)

zdne شكرا! المحلل اللغوي المنحل لم يشكو مني ، كان التحقق من صحة جيدة.

يجب أن يعطي المحلل تحذيراً. دعني أتحقق.

هل كانت هذه الصفحة مفيدة؟
0 / 5 - 0 التقييمات