JsonSchemaExporter.GetJsonSchemaAsNode Метод

Определение

Пространство имен:

System.Text.Json.Schema

Сборка:

System.Text.Json.dll

Пакет:

System.Text.Json v11.0.0-preview.5.26302.115

Перегрузки

Имя	Описание
GetJsonSchemaAsNode(JsonTypeInfo, JsonSchemaExporterOptions)	Создает схему JSON, соответствующую указанным метаданным контракта.
GetJsonSchemaAsNode(JsonSerializerOptions, Type, JsonSchemaExporterOptions)	Создает схему JSON, соответствующую метаданным контракта указанного типа.

GetJsonSchemaAsNode(JsonTypeInfo, JsonSchemaExporterOptions)

Исходный код:

JsonSchemaExporter.cs

Создает схему JSON, соответствующую указанным метаданным контракта.

public static System.Text.Json.Nodes.JsonNode GetJsonSchemaAsNode(this System.Text.Json.Serialization.Metadata.JsonTypeInfo typeInfo, System.Text.Json.Schema.JsonSchemaExporterOptions? exporterOptions = default);

static member GetJsonSchemaAsNode : System.Text.Json.Serialization.Metadata.JsonTypeInfo * System.Text.Json.Schema.JsonSchemaExporterOptions -> System.Text.Json.Nodes.JsonNode

<Extension()>
Public Function GetJsonSchemaAsNode (typeInfo As JsonTypeInfo, Optional exporterOptions As JsonSchemaExporterOptions = Nothing) As JsonNode

Параметры

typeInfo

JsonTypeInfo

Метаданные контракта, для которых создается схема.

exporterOptions

JsonSchemaExporterOptions

Объект exporterOptions, контролируемый созданием схемы.

Возвращаемое значение

JsonNode

Новый JsonNode экземпляр, определяющий схему JSON для typeInfo.

Исключения

ArgumentNullException

Одним из указанных параметров является null.

NotSupportedException

Параметр typeInfo содержит неподдерживаемые средства экспорта.

GetJsonSchemaAsNode(JsonSerializerOptions, Type, JsonSchemaExporterOptions)

Исходный код:

JsonSchemaExporter.cs

Создает схему JSON, соответствующую метаданным контракта указанного типа.

public static System.Text.Json.Nodes.JsonNode GetJsonSchemaAsNode(this System.Text.Json.JsonSerializerOptions options, Type type, System.Text.Json.Schema.JsonSchemaExporterOptions? exporterOptions = default);

static member GetJsonSchemaAsNode : System.Text.Json.JsonSerializerOptions * Type * System.Text.Json.Schema.JsonSchemaExporterOptions -> System.Text.Json.Nodes.JsonNode

<Extension()>
Public Function GetJsonSchemaAsNode (options As JsonSerializerOptions, type As Type, Optional exporterOptions As JsonSchemaExporterOptions = Nothing) As JsonNode

Параметры

options

JsonSerializerOptions

Экземпляр параметров, из которого необходимо разрешить метаданные контракта.

type

Type

Корневой тип, для которого создается схема JSON.

exporterOptions

JsonSchemaExporterOptions

Объект exporterOptions, контролируемый созданием схемы.

Возвращаемое значение

JsonNode

Новый JsonNode экземпляр, определяющий схему JSON для type.

Исключения

ArgumentNullException

Одним из указанных параметров является null.

NotSupportedException

Параметр options содержит неподдерживаемые средства экспорта.