Nishant M Gandhi

Trying to Understand World by Reading Listening & Thinking.

Some Bad JSON Schema Design to avoid for API

Don’t use dynamic keys

The keys in JSON schema should be fixed and documentable. Making keys dynamic in JSON schema, will make users left to guess the keys to retrieve data. It is also hard to document dynamic schema and create huge problem with schema versioning. Example of Dynamic Keys.

[{'1': XYZ}, {'20': PQR}, {'31': ABC}]