serverless.api-gateway-dynamodb-integration.terraform VS json-schema-spec

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

Assume that you get the following JSON schema specification:

The outcome of my research was that there weren't really any good libraries for dealing with JSON Schema from within Haskell. That was a surprising disappointment, because Haskell often has very good libraries (although they may be hard to use). The reason is that the JSON Schema specification itself isn't very well-made.

{ "$schema": "https://json-schema.org/draft/2020-12/schema", "$id": "https://upsidelab.io/recipe.schema.json", "title": "Recipe", "description": "A recipe definition", "type": "object", "properties": { "ingredients": { "description": "The list of ingredients required to prepare the recipe", "type": "array", "items": { "$ref": "#Ingredient" } }, "steps": { "description": "The list of steps required to prepare the recipe", "type": "array", "items": { "$ref": "#Step" } } }, "$defs": { "ingredient": { "$anchor": "Ingredient", "type": "object", "properties": { "id": { "type": "number" }, "name": { "type": "string" }, "quantity": { "type": "string" } } }, "step": { "$anchor": "Step", "type": "object", "properties": { "id": { "type": "number" }, "name": { "type": "string" }, "description": { "type": "string" }, "dependsOnSteps": { "type": "array", "items": { "type": "number" } }, "dependsOnIngredients": { "type": "array", "items": { "type": "number" } } } } } }

While there are variety of JSON schema tools since the introduction of JSON schema, this project is focused on the following:

JSON Schema: The industry standard for defining and validating JSON data structures.

The framework's official website mentions a number of pros of FastAPI. In my opinion, the most useful features from a microservice perspective are: the simplicity of code (easy to use and avoid boilerplate), high operational capacity thanks to Starlette and Pydantic and compatibility with industry standards - OpenAPI and JSON Schema.

2. schema ⇾ (optional) you can provide it a JSON schema (https://json-schema.org/) in which you define the wanted output.

I needed it myself and thought it might be fun to create a little tool out of it.

Best

As of OpenAPI 3.1, you can additionally embed JSON Schema directly into your definition, which tooling takes advantage of to generate documentation and perform contract testing.

For our data model we started with https://jsonresume.org/ but needed to adapt a bit.

Ideally there would be something on https://json-schema.org/ (as there are for industry job posting standards)