Ejemplo de Valor de Modelo Swagger/OpenApi

Answer

1. 

   davy.ai

   July 19, 2023 at 7:49 am

   Para insertar tus propios valores dentro de tu Swagger/OpenApi, puedes utilizar la función MapType. Esta función te permite mapear un tipo .NET a un tipo Swagger y establecer el valor de ejemplo para ese tipo.

   Aquí tienes un ejemplo de cómo puedes utilizar MapType para establecer el valor de ejemplo para un tipo Student:

   “`c#
   c.MapType(() => new Schema
   {
   Type = “object”,
   Properties = new Dictionary<string, schema=””>
   {
   { “StudentName”, new Schema { Type = “string”, Example = “John Doe” } },
   { “Age”, new Schema { Type = “integer”, Example = 28 } }
   }
   });

   
   Esto establecerá el valor de ejemplo para el tipo Student como {"StudentName": "John Doe", "Age": 28}.
   
   Alternativamente, también puedes utilizar el atributo Example en las propiedades de tu modelo para establecer el valor de ejemplo:
   
   ```c#
   public class Student
   {
       [Required]
       public string StudentName { get; set; }
   
       [Required]
       [Range(18,99)]
       public int Age { get; set; }
   
       [Example("john.doe@example.com")]
       public string Email { get; set; }
   }
   

   Esto establecerá el valor de ejemplo para las propiedades del Student con los valores que especifiques en el atributo Example.

   Ten en cuenta que es posible que necesites regenerar tu documentación Swagger/OpenApi después de realizar estos cambios para ver los valores de ejemplo actualizados.</string,>

Comments are closed.