es.davy.ai

Preguntas y respuestas de programación confiables

¿Tienes una pregunta?

Si tienes alguna pregunta, puedes hacerla a continuación o ingresar lo que estás buscando.

JSchemaGenerator -> Suprimir propiedad durante la generación en el esquema

21 Jul, 2023 Programación

Quiero generar un esquema a partir de un objeto. Hay algunas propiedades que no deben ser serializadas. La supresión funciona bien. Cuando genero el esquema, estas propiedades aparecen ahí, lo cual está mal para mi caso. Pero no pude encontrar nada sobre cómo puedo suprimir esas propiedades en la generación del esquema. ¿Cómo puedo hacer esto?


public class Foo {

    public object[] Bar { get; set; }

    ...

    public bool ShouldSerializeBar()
    {
        return false;
    }
}

...

using Newtonsoft.Json.Schema;
using Newtonsoft.Json.Schema.Generation;

JSchemaGenerator generator = new();
JSchema schema = generator.Generate(typeof(Foo)); // generar esquema a partir del objeto

{
    ...,
    "Bar": { // <- esto no debería mostrarse en el esquema JSON
      "type": [
        "string",
        "null"
      ]
    }
}
Tags:  , ,

Answer

  1. Avatar for davy.ai
    davy.ai

    Para evitar que ciertas propiedades aparezcan en el esquema JSON generado, puedes usar el atributo [JsonIgnore] en esas propiedades en tu clase Foo. Este atributo le indica al JsonSerializer que ignore esas propiedades durante la serialización.

    Aquí tienes un ejemplo de cómo puedes modificar tu código para excluir la propiedad Bar del esquema generado:

    public class Foo {
    [JsonIgnore]
    public object[] Bar { get; set; }

    ...
}

...

using Newtonsoft.Json.Schema;
using Newtonsoft.Json.Schema.Generation;

var generator = new JSchemaGenerator();
generator.GenerationProviders.Add(new CustomAttributesSchemaGenerationProvider()); // añade CustomAttributesSchemaGenerationProvider al generador
JSchema schema = generator.Generate(typeof(Foo)); // genera el esquema a partir del objeto

    Además de agregar el atributo [JsonIgnore], también se debe agregar CustomAttributesSchemaGenerationProvider para indicarle al generador que use atributos personalizados.

    Esta modificación asegurará que la propiedad Bar no se incluya en el esquema generado.

Comments are closed.