2 votes

Modèle de réponse contenant un tableau de différents types d'objet dans swagger

Je veux modéliser un objet de réponse contenant un tableau de différents types d'objets dans swagger, quelque chose comme ça:

{
   "table": [
        {
          "user" : []
        },
        {
          "customer": []
        },
        {
           "employee": []
        }
    ]
}

J'ai essayé une solution ci-dessous mais elle regroupe toutes les propriétés dans un seul objet { [ { "user": [], "customer": [] } ] }.

  réponses:
    200:
      schema:
        type: tableau
        éléments:
          type: objet
          propriétés:
            user:
              type: tableau
              éléments:
                $ref: '#/définitions/User'
            customer:
              type: tableau
              éléments:
                $ref: '#/définitions/Customer'
            employee:
              type: tableau
              éléments:
                $ref: '#/définitions/Employee'

2voto

William Cheng Points 4302

Cela sera pris en charge dans la prochaine version de la spécification OpenAPI (3.0) et voici la discussion associée à cette fonctionnalité:

https://github.com/OAI/OpenAPI-Specification/issues/57

Voici un exemple (fourni dans l'URL ci-dessus):

{
  "oneOf": [
    { "$ref": "Cat" },
    { "$ref": "Dog" }
  ]
}

Prograide.com

Prograide est une communauté de développeurs qui cherche à élargir la connaissance de la programmation au-delà de l'anglais.
Pour cela nous avons les plus grands doutes résolus en français et vous pouvez aussi poser vos propres questions ou résoudre celles des autres.

Powered by:

X