NJsonSchema 11.0.0-preview001 - API Reference

<PackageReference Include="NJsonSchema" Version="11.0.0-preview001" />

API Differences between 11.0.0-preview001 and 10.5.1

84 Additions 33 Removals

NJsonSchema

public class ConversionUtilities
- public static void Tab(string input, int tabCount, TextWriter writer)
public static class JsonFormatStrings
- public const string Duration = "duration"
public class JsonSchema : JsonReferenceBase<JsonSchema>, IDocumentPathProvider, IJsonReference, IJsonReferenceBase, IJsonExtensionObject
- public bool HasActualProperties { get; }
- public static Task<JsonSchema> FromJsonAsync(Stream stream, CancellationToken cancellationToken = default)
- public static JsonSchema FromSampleJson(string data)
- public static JsonSchema FromType<TType>()
- public static JsonSchema FromType(Type type)
- public static JsonSchema FromType<TType>(JsonSchemaGeneratorSettings settings)
- public static JsonSchema FromType(Type type, JsonSchemaGeneratorSettings settings)
- public static Task<JsonSchema> FromJsonAsync(Stream stream, string documentPath, Func<JsonSchema, JsonReferenceResolver> referenceResolverFactory, CancellationToken cancellationToken = default)
- public ICollection<ValidationError> Validate(string jsonData, IFormatValidator[] customValidators)
- public ICollection<ValidationError> Validate(JToken token, IFormatValidator[] customValidators)
- public ICollection<ValidationError> Validate(string jsonData, SchemaType schemaType, IFormatValidator[] customValidators)
- public ICollection<ValidationError> Validate(JToken token, SchemaType schemaType, IFormatValidator[] customValidators)
- public ICollection<ValidationError> Validate(string jsonData, JsonSchemaValidatorSettings settings = null)
- public ICollection<ValidationError> Validate(JToken token, JsonSchemaValidatorSettings settings = null)
- public ICollection<ValidationError> Validate(string jsonData, SchemaType schemaType, JsonSchemaValidatorSettings settings = null)
- public ICollection<ValidationError> Validate(JToken token, SchemaType schemaType, JsonSchemaValidatorSettings settings = null)
public static class JsonSchemaReferenceUtilities
- public static Task UpdateSchemaReferencesAsync(object rootObject, JsonReferenceResolver referenceResolver)
- public static Task UpdateSchemaReferencesAsync(object rootObject, JsonReferenceResolver referenceResolver, CancellationToken cancellationToken = default)
public class SampleJsonDataGenerator
- public SampleJsonDataGenerator()
- public SampleJsonDataGenerator(SampleJsonDataGeneratorSettings settings)
- public JToken Generate(JsonSchema schema)
public class SampleJsonDataGeneratorSettings
- public bool GenerateOptionalProperties { get; set; }
- public int MaxRecursionLevel { get; set; }
- public SampleJsonDataGeneratorSettings()

NJsonSchema.Converters

public class JsonExceptionConverter : JsonConverter
public class JsonInheritanceConverter : JsonConverter
public class JsonReferenceConverter : JsonConverter
public class JsonInheritanceConverter<TBase> : JsonConverter<TBase>
- public static IDictionary<string, Type> AdditionalKnownTypes { get; }
- public virtual string DiscriminatorName { get; }
- public JsonInheritanceConverter()
- public JsonInheritanceConverter(string discriminatorName)
- protected virtual Type GetDiscriminatorType(JsonElement jObject, Type objectType, string discriminatorValue)
- public virtual string GetDiscriminatorValue(Type type)
public class JsonInheritanceConverterAttribute : JsonConverterAttribute
- public static string DefaultDiscriminatorName { get; }
- public string DiscriminatorName { get; }
- public JsonInheritanceConverterAttribute(Type baseType, string discriminatorName = "discriminator")

NJsonSchema.Generation

public class DefaultReflectionService : IReflectionService
public enum EnumHandling
public interface IReflectionService
- string ConvertEnumValue(object value, JsonSchemaGeneratorSettings settings)
- void GenerateProperties(JsonSchema schema, ContextualType contextualType, JsonSchemaGeneratorSettings settings, JsonSchemaGenerator schemaGenerator, JsonSchemaResolver schemaResolver)
- string GetPropertyName(ContextualAccessorInfo accessorInfo, JsonSchemaGeneratorSettings settings)
- bool IsStringEnum(ContextualType contextualType, JsonSerializerSettings serializerSettings)
- bool IsStringEnum(ContextualType contextualType, JsonSchemaGeneratorSettings settings)
public interface IXmlDocsSettings
- bool ResolveExternalXmlDocumentation { get; }
- bool UseXmlDocumentation { get; }
- XmlDocsFormattingMode XmlDocumentationFormatting { get; set; }
public class JsonSchemaGenerator
- public static JsonSchema FromType<TType>(JsonSchemaGeneratorSettings settings)
- public static JsonSchema FromType(Type type, JsonSchemaGeneratorSettings settings)
- public void AddProperty(JsonSchema parentSchema, ContextualAccessorInfo property, JsonTypeDescription propertyTypeDescription, string propertyName, Attribute requiredAttribute, bool hasRequiredAttribute, bool isNullable, object defaultValue, JsonSchemaResolver schemaResolver)
- public virtual string GetPropertyName(JsonProperty jsonProperty, ContextualAccessorInfo accessorInfo)
- public object GetDataMemberAttribute(ContextualAccessorInfo accessorInfo, Type parentType)
- public bool IsAbstractProperty(ContextualMemberInfo memberInfo)
- public bool IsPropertyIgnoredBySettings(ContextualAccessorInfo accessorInfo)
public abstract class JsonSchemaGeneratorSettings : IXmlDocsSettings
- public IContractResolver ActualContractResolver { get; }
- public JsonSerializerSettings ActualSerializerSettings { get; }
- public IContractResolver ContractResolver { get; set; }
- public EnumHandling DefaultEnumHandling { get; set; }
- public PropertyNameHandling DefaultPropertyNameHandling { get; set; }
- public bool ResolveExternalXmlDocumentation { get; set; }
- public object SerializerOptions { get; set; }
- public JsonSerializerSettings SerializerSettings { get; set; }
- public bool UseXmlDocumentation { get; set; }
- public XmlDocsFormattingMode XmlDocumentationFormatting { get; set; }
- public JsonContract ResolveContract(Type type)
public enum PropertyNameHandling
public class SampleJsonDataGenerator
public class SampleJsonSchemaGenerator
public abstract class ReflectionServiceBase<TSettings> : IReflectionService where TSettings : JsonSchemaGeneratorSettings
- protected ReflectionServiceBase()
- public abstract string ConvertEnumValue(object value, TSettings settings)
- public abstract void GenerateProperties(JsonSchema schema, ContextualType contextualType, TSettings settings, JsonSchemaGenerator schemaGenerator, JsonSchemaResolver schemaResolver)
- public JsonTypeDescription GetDescription(ContextualType contextualType, ReferenceTypeNullHandling defaultReferenceTypeNullHandling, TSettings settings)
- protected virtual JsonTypeDescription GetDescription(ContextualType contextualType, TSettings settings, Type originalType, bool isNullable, ReferenceTypeNullHandling defaultReferenceTypeNullHandling)
- public abstract string GetPropertyName(ContextualAccessorInfo accessorInfo, JsonSchemaGeneratorSettings settings)
- protected virtual bool IsArrayType(ContextualType contextualType)
- protected virtual bool IsBinary(ContextualType contextualType)
- protected virtual bool IsDictionaryType(ContextualType contextualType)
- public virtual bool IsNullable(ContextualType contextualType, ReferenceTypeNullHandling defaultReferenceTypeNullHandling)
- public virtual bool IsStringEnum(ContextualType contextualType, TSettings settings)
public class SchemaProcessorContext
- public ContextualType ContextualType { get; }
- public SchemaProcessorContext(Type type, JsonSchema schema, JsonSchemaResolver resolver, JsonSchemaGenerator generator, JsonSchemaGeneratorSettings settings)
- public SchemaProcessorContext(ContextualType contextualType, JsonSchema schema, JsonSchemaResolver resolver, JsonSchemaGenerator generator, JsonSchemaGeneratorSettings settings)
public static class SystemTextJsonUtilities
public class SystemTextJsonReflectionService : ReflectionServiceBase<SystemTextJsonSchemaGeneratorSettings>
- public SystemTextJsonReflectionService()
public static class SystemTextJsonSchemaGenerator
- public static JsonSchema FromType<TType>()
- public static JsonSchema FromType(Type type)
- public static JsonSchema FromType<TType>(SystemTextJsonSchemaGeneratorSettings settings)
- public static JsonSchema FromType(Type type, SystemTextJsonSchemaGeneratorSettings settings)
public class SystemTextJsonSchemaGeneratorSettings : JsonSchemaGeneratorSettings
- public JsonSerializerOptions SerializerOptions { get; set; }
- public SystemTextJsonSchemaGeneratorSettings()
public static class XmlDocsSettingsExtensions
- public static XmlDocsOptions GetXmlDocsOptions(this IXmlDocsSettings settings)

NJsonSchema.Infrastructure

public class JsonSchemaSerialization
- public static T FromJson<T>(Stream stream, IContractResolver contractResolver)
- public static Task<T> FromJsonAsync<T>(Stream stream, SchemaType schemaType, string documentPath, Func<T, JsonReferenceResolver> referenceResolverFactory, IContractResolver contractResolver, CancellationToken cancellationToken = default)
public static class TypeExtensions
- public static string GetDescription(this CachedType type)
- public static string GetDescription(this ContextualAccessorInfo accessorInfo)
- public static string GetDescription(this ContextualParameterInfo parameter)
- public static string GetDescription(this CachedType type, IXmlDocsSettings xmlDocsSettings)
- public static string GetDescription(this ContextualAccessorInfo accessorInfo, IXmlDocsSettings xmlDocsSettings)
- public static string GetDescription(this ContextualParameterInfo parameter, IXmlDocsSettings xmlDocsSettings)
- public static string GetName(this ContextualAccessorInfo accessorInfo)

NJsonSchema.Validation

public class JsonSchemaValidator
- public JsonSchemaValidator(JsonSchemaValidatorSettings settings)
public class JsonSchemaValidatorSettings
- public IEnumerable<IFormatValidator> FormatValidators { get; set; }
- public StringComparer PropertyStringComparer { get; set; }
- public JsonSchemaValidatorSettings()
- public void AddCustomFormatValidator(IFormatValidator formatValidator)