schemars/docs/3-generating.md
2019-12-26 18:26:14 +00:00

1.2 KiB

layout title nav_order permalink
default Generating Schemas 4 /generating/

Generating Schemas

The easiest way to generate a schema for a type that implements is to use the schema_for! macro, like so:

let my_schema = schema_for!(MyStruct);

This will create a schema that conforms to JSON Schema Draft 7, but this is liable to change in a future version of Schemars if support for other JSON Schema versions is added.

If you want more control over how the schema is generated, you can use the gen module. There are two main types in this module:

  • SchemaSettings, which defines what JSON Schema features should be used when generating schemas (for example, how Options should be represented).
  • SchemaGenerator, which manages the generation of a schema document.

See the API documentation for more info on how to use those types for custom schema generation.