Api-blueprint: Jenis nullable tidak berfungsi dalam deklarasi metode

Dibuat pada 13 Apr 2016 · 3Komentar · Sumber: apiaryio/api-blueprint

Saya mencoba menggunakan tipe nullable di mson saya mengikuti sampel dalam dokumentasi, tetapi gagal dengan kesalahan semantik.

Tolong bantu saya untuk mencari tahu apa yang salah dengan mson saya dan bagaimana membuat dokumentasi yang benar untuk kasus penggunaan saya?

Terima kasih!

Apiary.io Question

Sumber

danilvalov

👍1

Komentar yang paling membantu

Saya hanya ingin menunjukkan bahwa ini sekarang telah dikerahkan ke Apiary (tanpa beta).

Sebagai contoh, Anda dapat menggunakan nullable seperti berikut:

+ Response 200 (application/json)
    + Attributes
        + example1 (string, optional, nullable) - An example optional nullable string
        + example2: value (string, optional, nullable) - An example optional nullable string with a sample value

Di mana ini akan menghasilkan contoh payload berikut:

{
  "example1": null,
  "example2": "value"
}

Bersama dengan skema JSON berikut:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "example1": {
      "type": [
        "string",
        "null"
      ],
      "description": "An example optional nullable string"
    },
    "example2": {
      "type": [
        "string",
        "null"
      ],
      "description": "An example optional nullable string with a sample value"
    }
  }
}

Tabel atribut di Apiary belum menyebutkan bahwa nilainya nullable , tetapi ini akan datang.

screen shot 2016-06-20 at 17 46 45

kylef pada 20 Jun 2016

👍4

Semua 3 komentar

Hai @danilvalov ,

Apiary memang memiliki beta untuk meningkatkan rendering atribut, yang mencakup dukungan untuk nullability. Anda dapat menemukan lebih banyak tentang beta di https://github.com/apiaryio/api-blueprint/issues/191#issuecomment -178044764 bersama dengan cara bergabung.

Salam,

Kyle

kylef pada 13 Apr 2016