LGV_MeetingServer VS json-schema-spec

I find “self-documentation” often doesn’t actually work. It’s great in theory, but often falls down, in practice.

I often need to preface my config stuff with fairly substantial comment blocks that discuss the reasoning behind the configuration.

Here’s an example: https://github.com/LittleGreenViper/LGV_MeetingServer/blob/m...

I generally have a “What Problem Does This Solve?” section in my READMEs.

https://github.com/LittleGreenViper/LGV_TZ_Lookup#what-probl...

https://github.com/LittleGreenViper/LGV_MeetingServer#what-p...

https://github.com/RiftValleySoftware/RVS_Spinner#what-probl...

https://github.com/RiftValleySoftware/RVS_BlueThoth#what-pro...

https://github.com/RiftValleySoftware/RVS_PersistentPrefs#wh...

etc.

Yep and that comes from JSON Schema: https://json-schema.org/

I believe recent versions of OpenAPI are "compatible" with JSON Schema (at least they "wanted to be" last I checked as I was implementing some schema converters).

Even TypeScript is not enough to represent all of JSON Schema! But it gets close (perhaps if you remove validation rules and stuff like that it's a full match).

But even something like Java can represent most of it pretty well, specially since sealed interfaces were added. I know because I've done it :).

models.tf where I centralized all the Data model that API Gateway uses to perform input and output checks. Those use the JSON-schema specification. GitHub - psantus/serverless.api-gateway-dynamodb-integration.terraform

In the meantime, we are going to expand our backend with two endpoints: one for fetching data and another one for creating data. Fastify provides out-of-the-box support for API serialization and validation through its schema-based approach built on top of JSON Schema. Through the schema option, we can attach a schema definition to each route.

JSON-schema to define templates for request and response contents.

The syntax used to define the output is called JSON Schema. It is a standard way to define the structure of a JSON object. If you know zod, the spirit is similar. Based on Swarmion's roadmap, it will be possible to use zod schemas to defined contracts in the future, which will be super cool!