Api-blueprint: Le type Nullable ne fonctionne pas dans la déclaration de méthode

Créé le 13 avr. 2016 · 3Commentaires · Source: apiaryio/api-blueprint

J'essaie d'utiliser le type nullable dans mon exemple mson suivant dans la documentation, mais cela échoue avec une erreur sémantique.

S'il vous plaît, aidez-moi à comprendre ce qui ne va pas avec mon mson et comment créer une documentation correcte pour mon cas d'utilisation ?

Merci!

Apiary.io Question

Source

danilvalov

👍1

Commentaire le plus utile

Je veux juste souligner que cela a maintenant été déployé sur Apiary (sans version bêta).

À titre d'exemple, vous pouvez utiliser nullable comme suit :

+ 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

Où cela se traduirait par un exemple de charge utile des éléments suivants :

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

Avec le schéma JSON suivant :

{
  "$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"
    }
  }
}

Le tableau des attributs dans Apiary ne mentionne pas encore que la valeur est nullable , mais cela arrive.

screen shot 2016-06-20 at 17 46 45

kylef le 20 juin 2016

👍4

Tous les 3 commentaires

Salut @danilvalov , Apiary n'utilise pas la dernière version de l'API Blueprint Parser qui ajoute la prise en charge de la nullabilité.

Apiary a une version bêta pour améliorer le rendu des attributs, qui inclut la prise en charge de la nullabilité. Vous pouvez en savoir plus sur la version bêta sur https://github.com/apiaryio/api-blueprint/issues/191#issuecomment -178044764 ainsi que sur la façon de la rejoindre.

Salutations,

Kyle

kylef le 13 avr. 2016