Skip to content

Latest commit

 

History

History
66 lines (59 loc) · 3.34 KB

README.md

File metadata and controls

66 lines (59 loc) · 3.34 KB
Raw

Java JSON Schema Generation – Module Addon

Build Status Maven Central

Module for the victools/jsonschema-generator – deriving JSON Schema attributes from annotations

Features

  • Indicate a title on property(field/method) @JsonSchema(title="...")
  • Indicate a description on property(field/method) @JsonSchema(description="...")
  • Indicate a format on string property(field/method) @JsonSchema(format=TypeFormat.DATE)
  • Indicate a pattern on string property(field/method) @JsonSchema(pattern="...")
  • Indicate a minimum length on string property(field/method) @JsonSchema(minLength="...")
  • Indicate a maximum length on string property(field/method) @JsonSchema(maxLength="...")
  • Indicate a minimum value on number property(field/method) @JsonSchema(min=0)
  • Indicate a maximum value on number property(field/method) @JsonSchema(max=10)
  • Indicate a minimum exclusive value on number property(field/method) @JsonSchema(min=0, exclusiveMin = true)
  • Indicate a maximum exclusive value on number property(field/method) @JsonSchema(max=10, exclusiveMax = true)
  • Indicate a multiple of value on number property(field/method) @JsonSchema(multipleOf=2)
  • Indicate a default value on property(field/method) @JsonSchema(defaultValue="...")
  • Indicate if property is required(field/method) @JsonSchema(required=true)
  • Optionally ignore a property(field/method) @JsonSchema(ignore=true)
  • Indicate new metadata(field/method) @JsonSchema(metadata={@JSData(key="...",value="...")})

Usage

Dependency (Maven)

<dependency>
    <groupId>com.github.imifou</groupId>
    <artifactId>jsonschema-module-addon</artifactId>
    <version>1.2.1</version>
</dependency>

Code

Passing into SchemaGeneratorConfigBuilder.with(Module)

import com.github.victools.jsonschema.generator.SchemaGeneratorConfigBuilder;
import com.github.imifou.jsonschema.module.addon.AddonModule;
AddonModule module = new AddonModule();
SchemaGeneratorConfigBuilder configBuilder = new SchemaGeneratorConfigBuilder(objectMapper).with(module);

Complete Example

import com.github.imifou.jsonschema.module.addon.AddonModule;
import com.fasterxml.jackson.databind.JsonNode;
import com.fasterxml.jackson.databind.ObjectMapper;
import com.github.victools.jsonschema.generator.OptionPreset;
import com.github.victools.jsonschema.generator.SchemaGenerator;
import com.github.victools.jsonschema.generator.SchemaGeneratorConfig;
import com.github.victools.jsonschema.generator.SchemaGeneratorConfigBuilder;
ObjectMapper objectMapper = new ObjectMapper();
AddonModule module = new AddonModule();
SchemaGeneratorConfigBuilder configBuilder = new SchemaGeneratorConfigBuilder(objectMapper,OptionPreset.PLAIN_JSON)
  .with(module);
SchemaGeneratorConfig config = configBuilder.build();
SchemaGenerator generator = new SchemaGenerator(config);
JsonNode jsonSchema = generator.generateSchema(getEntityClass());
        
System.out.println(jsonSchema.toString());