Api-blueprint: El tipo que acepta valores NULL no funciona dentro de la declaración del método

Creado en 13 abr. 2016  ·  3Comentarios  ·  Fuente: apiaryio/api-blueprint

Estoy tratando de usar un tipo que acepta valores

Por favor, ayúdeme a descubrir qué está mal con mi mson y cómo hacer la documentación correcta para mi caso de uso.

¡Gracias!

Apiary.io Question

Comentario más útil

Solo quiero señalar que esto ahora se ha implementado en Apiary (sin una versión beta).

Como ejemplo, puede usar un valor anulable como el siguiente:

+ 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

Donde esto daría como resultado un ejemplo de carga útil de lo siguiente:

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

Junto con el siguiente esquema JSON:

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

La tabla de atributos en Apiary aún no menciona que el valor es anulable , pero esto está por llegar.

screen shot 2016-06-20 at 17 46 45

Todos 3 comentarios

Hola @danilvalov ,

Apiary tiene una versión beta para mejorar la representación de atributos, que incluye soporte para nulabilidad. Puede encontrar más información sobre la versión beta en https://github.com/apiaryio/api-blueprint/issues/191#issuecomment -178044764 junto con cómo unirse.

Saludos,

Kyle

Solo quiero señalar que esto ahora se ha implementado en Apiary (sin una versión beta).

Como ejemplo, puede usar un valor anulable como el siguiente:

+ 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

Donde esto daría como resultado un ejemplo de carga útil de lo siguiente:

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

Junto con el siguiente esquema JSON:

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

La tabla de atributos en Apiary aún no menciona que el valor es anulable , pero esto está por llegar.

screen shot 2016-06-20 at 17 46 45

Esto ahora es visible, en ApiaryUI :
image

¿Fue útil esta página
0 / 5 - 0 calificaciones