openapi-mock VS json-schema-spec

Since the OpenAPI can effectively describe our resources, we can reuse it to generate a dummy server that can be later used for development and testing purposes without bootstrapping any actual services. There some tools available that can help us with this task, such as Prism, OpenAPI Mock, OpenAPI Backend and the MSW library we have already seen.

{ "$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)

Or maybe extend this with types for the timestamp, `@ms:1623132000` or `@unix:1623132000`, so in a value: `{"now":@unix:1623132000}`

Mongo types the field name, `{"$date":1623132000}`, if I'm not mistaken. Rust style would be `1623132000_unix`.

Or with anticipation of a more full typing system, where the time is explicitly named:

`{"now": unix:1623132000}`

For now, when I need typing, I use https://json-schema.org