Skip to main content

OpenAPI specification validator and converter to Marshmallow schemas.

Project description

Schema-First

Validate and convert OpenAPI specification via Marshmallow schemas to Marshmallow schemas.

Features

  • OpenAPI specification validate.
  • Convert OpenAPI schemas to Marshmallow schemas.

Installation

Recommended using the latest version of Python. Schema-First supports Python 3.14 and newer.

Install and update using pip:

$ pip install -U schema_first

Example

Create specification - openapi.yaml:

openapi: 3.1.1
info:
    title: Example API for testing Flask-First
    version: 1.0.1
paths:
    /endpoint:
        get:
            operationId: endpoint
            responses:
                '200':
                    content:
                        application/json:
                            schema:
                                properties:
                                    message:
                                        type: string
                                type: object
                    description: OK

Create script - main.py:

from pathlib import Path
from pprint import pprint

from schema_first.specification import Specification

spec_file = Path('openapi.yaml')
spec = Specification(spec_file)
spec.load()

pprint(spec.reassembly_spec)
print(
    'Marshmallow schema generated from OpenAPI schema',
    spec.reassembly_spec['paths']['/endpoint']['get']['responses']['200']['content'][
        'application/json'
    ]['schema'],
)

More example see to ./example folder.

Additional documentation

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

schema_first-0.14.4.tar.gz (14.4 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

schema_first-0.14.4-py3-none-any.whl (23.5 kB view details)

Uploaded Python 3

File details

Details for the file schema_first-0.14.4.tar.gz.

File metadata

  • Download URL: schema_first-0.14.4.tar.gz
  • Upload date:
  • Size: 14.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.14.6

File hashes

Hashes for schema_first-0.14.4.tar.gz
Algorithm Hash digest
SHA256 e9c531f9f3a8ec4352173f19799f2cca2c7c557816a34795cca4400bbaaacbf7
MD5 6b0b85d50acaaa64b1d9e9099e467f7a
BLAKE2b-256 9ae55e46a5c4b3021fb80622058c58ce0438aea198a82cf2c0a20cddfb07d595

See more details on using hashes here.

File details

Details for the file schema_first-0.14.4-py3-none-any.whl.

File metadata

  • Download URL: schema_first-0.14.4-py3-none-any.whl
  • Upload date:
  • Size: 23.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.14.6

File hashes

Hashes for schema_first-0.14.4-py3-none-any.whl
Algorithm Hash digest
SHA256 77aa631ab7ef13e041000a3e84a5fcce8d86e7c682ddb1c6e000052dda31314d
MD5 ba374707b4ddde48a29893d7cefa8737
BLAKE2b-256 74b1056eef3571fad2565938e76ebba3e653e5f4215186ab0ee3f9a3f645b07b

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page