Api-blueprint: Tidak dapat mereferensikan objek Struktur Data dalam array

Dibuat pada 8 Mei 2015  ·  6Komentar  ·  Sumber: apiaryio/api-blueprint

Hai, terima kasih untuk produk yang luar biasa!

Saya mendokumentasikan menggunakan format JSONAPI, dan saya mengalami masalah dengan mengekspresikan objek dalam array. Ini diperlukan karena spesifikasi JSONAPI untuk hubungan ke-banyak yang tidak kosong.

Berikut ini contoh kode saya:

# 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)

Jika Anda merender ini di tempat pemeliharaan lebah, Anda akan melihat bahwa array dietary_requirements kosong, meskipun itu merujuk ke Struktur Data Linkage .

screen shot 2015-05-08 at 22 03 23

Bantuan apa pun akan sangat dihargai.

Question

Komentar yang paling membantu

@pete001 Anda juga dapat menentukan jenis apa pun sebagai konten array seperti:

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

Semua 6 komentar

Coba ubah ini:

- *dietary_requirements* (array)
    - Include Linkage

Untuk ini:

- *dietary_requirements* (array[Linkage])

screen shot 2015-05-08 at 22 08 05

Saya tidak percaya itu mungkin untuk menggunakan mixin ( include ) dengan array seperti dalam contoh ini.

Wow, benar-benar menakjubkan! Terima kasih banyak atas tanggapannya yang cepat, ini bekerja dengan sempurna :senyum:

@kylef benar – Include dimaksudkan untuk bekerja dengan objek saja ( spec ).

Namun parser harus memperingatkan pada kesempatan ini – bukankah ini masalahnya? //cc @pksunkara

@pete001 Anda juga dapat menentukan jenis apa pun sebagai konten array seperti:

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

Terima kasih @zdne! Pengurai peternakan lebah tidak mengeluh kepada saya, memvalidasi ok.

Parser harus memberikan peringatan. Biarkan saya memeriksa.

Apakah halaman ini membantu?
0 / 5 - 0 peringkat

Masalah terkait

mootpointer picture mootpointer  ·  4Komentar

spark-developer picture spark-developer  ·  12Komentar

robbinjanssen picture robbinjanssen  ·  6Komentar

bazo picture bazo  ·  8Komentar

BigBlueHat picture BigBlueHat  ·  3Komentar