schemax 2.0.2

district42 to JSON-Schema translator and vise versa

SchemaMaximal

district42 schemas ⇆ JSON Schema

Installation

pip3 install schemax

Usage

Translation

>>> import schemax
>>> from d42 import schema
>>> ExampleSchema = schema.str.len(1, 10)
>>> schemax.to_json_schema(ExampleSchema)
{'type': 'string', 'minLength': 1, 'maxLength': 10}

Also, you could use schemax to translate from JSON-Schema to d42 and generate tests interfaces (in future releases) via command line:

$ schemax translate schema.json

Translation from JSON-Schema to d42-schema for schema.json:
schema.dict({
    'number': schema.int.min(1),
    optional('street_name'): schema.str,
    ...: ...
})

schema.json:

{
  "type": "object",
  "properties": {
    "number": { "type": "integer", "minimum": 1 },
    "street_name": { "type": "string" }
  },
  "required": ["number"],
  "additionalProperties": true
}

Generation

schemax generate my-schema.yml

This command will generate request and response schemas files, API interface and basic scenarios.

You could add basic url to your API as following: --base-url="http://api.example.com".

Making your schemas and interfaces more "friendly" could --humanize flag.

Using SchemaData object in code

import yaml
from schemax import collect_schema_data, SchemaData 

from typing import List

# Also could be JSON OpenAPI file
with open('my_openapi.yaml') as schema_file:
    raw_schema = yaml.load(schema_file, yaml.FullLoader)
    
    parsed_data: List[SchemaData] = collect_schema_data(raw_schema)
    for item in parsed_data:
        print(item.path)
        print(item.response_schema_d42)
        ...

All the data is stored in SchemaData object, which has the following fields:

• http_method: HTTP method of the request.
• path: URL path of the request.
• converted_path: URL path converted to the camel-case for usage in schemax generation.
• args: Arguments of the request.
• queries: Query parameters of the request. Currently unsupported and always '[]'.
• interface_method: Interface name for usage in schemax generation.
• interface_method_humanized: Interface 'humanized' name for usage in schemax generation.
• status: Status code for specified schemas.
• schema_prefix: Schema prefix name for usage in schemax generation.
• schema_prefix_humanized: Schema prefix 'humanized' name for user in schemax generation.
• response_schema: Normalized response schema (without $ref).
• response_schema_d42: Converted to d42 response_schema.
• request_schema: Normalized request schema (without $ref).
• request_schema_d42: Converted to d42 request_schema.
• tags: Tags of the request from OpenAPI schema.

Supported d42 -> JSON Schema types and features

(✅ - done; 🔧 - planned support; ❌ - unsupportable)

• None:
  • ✅ schema.none
• Bool:
  • ✅ schema.bool
  • ✅ schema.bool(value)
• Int:
  • ✅ schema.int
  • ✅ schema.int(value)
  • ✅ schema.int.min(value)
  • ✅ schema.max(value)
• Float:
  • ✅ schema.float
  • ✅ schema.float(value)
  • ✅ schema.float.min(value)
  • ✅ schema.float.max(value)
  • 🔧 schema.float.precision(value)
• Str:
  • ✅ schema.str
  • ✅ schema.str(value)
  • ✅ schema.str.len(length)
  • ✅ schema.str.len(min_length, max_length)
  • ✅ schema.str.alphabet(letters)
  • ✅ schema.str.contains(substr)
  • ✅ schema.regex(pattern)
• List:
  • ✅ schema.list
  • ✅ schema.list(elements)
  • ✅ schema.list(type)
  • ✅ schema.list(type).len(length)
  • ✅ schema.list(type).len(min_length, max_length)
• Dict:
  • ✅ schema.dict
  • ✅ schema.dict({key: value}) strict
  • ✅ schema.dict({key: value, ...: ...}) relaxed
• Any:
  • ✅ schema.any
  • ✅ schema.any(*types)
• ❌ schema.bytes

Supported JSON Schema -> d42 types and features

(✅ - done; 🔧 - planned support; ❌ - unsupportable)

• ✅ null
• ✅ boolean
• ✅ integer
  • ✅ minimum
  • ✅ maximum
  • ✅ exclusiveMinimum Keep in mind, that we're just taking exclusiveMinimum + 1 as schema.int.min
  • ✅ exclusiveMaximum Keep in mind, that we're just taking exclusiveMaximum - 1 as schema.int.max
  • ❌ multiples
• ✅ number
  • ✅ minimum
  • ✅ maximum
  • 🔧 exclusiveMinimum
  • 🔧 exclusiveMaximum
  • ❌ multiples
• ✅ string
  • ✅ minLength
  • ✅ maxLength
  • ✅ pattern
  • ❌ format
• ✅ array
  • ✅ items
  • ✅ length
  • ✅ prefixItems
  • ✅ unevaluatedItems
  • ❌ uniqueness
• ✅ object
  • ✅ properties
  • ❌ patterProperties
  • ❌ additionalProperties
  • ✅ requiredProperties
  • ❌ propertyName
  • ❌ size