Home

Roadmap | SDK Development | Contribute

Most of the documentation also applies for DTO schemas in OpenAPI/Swagger documents generated with NSwag.

JSON Schema

NuGet Package: NJsonSchema

• JsonSchema: Read, modify and write JSON Schemas
• JsonSchemaValidator: If you need more control over the validation process

JSON Schema generators

NuGet Package: NJsonSchema

• JsonSchemaGenerator: Generate JSON Schemas from .NET Types via Reflection.
  • JsonSchemaGeneratorSettings
• SampleJsonSchemaGenerator: Generate JSON Schemas from sample JSON data

Topics:

• XML Documentation: Loading C# code documentation.
• Enums: Control 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.
• Value Generators: Converts JSON Schema default values to C# or TypeScript specific values

Code Generators

NuGet Packages: 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: Modify or extend the code generator templates.