Synadia Platform
Schema Registry Clients
Overview
After the configuring and deploying a Schema Registry, clients can be then be used with Registry to validate NATS message payloads.
Clients are broken up into two separate components; those that interact with the Schema Registry directly and those that validate client payloads against specific schemas.
SDK
The SDK is used to:
- Create
- Read
- Update
- Delete
It is possible to interact with schemas using the following methods:
- Control Plane API,
- Control Plane UI, and
- Each languages SDK.
If using the SDK's, refer to each libraries documentation for the specifics. Links to each supported language are found here.
Validation
Validation clients ensure that a payload conforms to a schema from the registry and will cache any invalid payloads before they become a problem. Clients can validate before sending and when receiving using their specific libraries. This diagram shows validation on both the Publisher and Consumer sides to give a complete snapshot of how payload validation works.
Although each language's implementation will be slightly different based on language constraints the concept is the same.
Client libraries will do the following:
- Authenticate with NATS using a JWT.
- Validate a payload against a schema
- Store schemas locally to prevent unnecessary round-trips to the Schema Registry
Libraries
More languages will be added as they become available.