Home

Roadmap | SDK Development | Contribute

JSON Schema generator

JsonSchemaGenerator

Topics:

• XML Documentation: Loading C# code documentation
• Enums: string and integer handling
• Inheritance with Swagger or OpenAPI discriminators

Customizations

• Custom Schema Properties: Add custom properties to the generated JSON objects (e.g. "x-documentation-link").
• Type Mappers: Type mappers allow you to generate a custom JSON Schema for a given .NET type.
• Schema Processors: Post process the generation of the schema or child schemas

Code generators

Package: *NJsonSchema.CodeGeneration. **

• CSharpGenerator
  • CSharpGeneratorSettings
• TypeScriptGenerator
  • TypeScriptGeneratorSettings
• (CodeGeneratorSettingsBase)

Customizations

• Property Name Generators: Customize the names of property names
• Schema Name Generators: Customize the names of schema 'definitions' keys.
• Type Name Generators: Customize the way how C#/TypeScript class or interface names are generated.
• Templates

Classes

Package: NJsonSchema

• JsonSchema4
• JsonSchemaValidator: If you need more control over the validation process
• JsonSchemaGenerator
  • JsonSchemaGeneratorSettings