OpenAPI-Spec Support

OpenAPI30Compiler: Compiles a Zangar schema to OpenAPI 3.0.x schema object.

import zangar as z
from zangar.compilation import OpenAPI30Compiler

assert OpenAPI30Compiler().compile(
    z.struct({
        "name": z.str(),
        "age": z.int().gte(0),
        "address": z.struct({
            "street": z.str(),
            "city": z.str(),
            "state": z.str(),
        })
    })
) == {
    'type': 'object',
    'properties': {
        'name': {'type': 'string'},
        'age': {
            'type': 'integer',
            'minimum': 0
        },
        'address': {
            'type': 'object',
            'properties': {
                'street': {'type': 'string'},
                'city': {'type': 'string'},
                'state': {'type': 'string'}
            },
            'required': ['street', 'city', 'state']
        }
    },
    'required': ['name', 'age', 'address']
}

Additional OAS schema object properties

def is_email(string):
    return '@' in string


assert OpenAPI30Compiler().compile(z.struct({
    'username': z.str().ensure(is_email, meta={
        'oas': {
            'format': 'email'
        }
    }),
    'password': z.str(meta={
        'oas': {
            'format': 'password'
        }
    }),
})) == {
    'type': 'object',
    'properties': {
        'username': {
            'type': 'string',
            'format': 'email'
        },
        'password': {
            'type': 'string',
            'format': 'password'
        }
    },
    'required': ['username', 'password']
}