Skip to main content

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

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.7.tar.gz (14.5 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.7-py3-none-any.whl (23.6 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: schema_first-0.14.7.tar.gz
  • Upload date:
  • Size: 14.5 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.7.tar.gz
Algorithm Hash digest
SHA256 48669345f8493a62328a455fc15bd810cf49759112edf85754c1089eb7e5bb1a
MD5 73f557edbd951aebaf09d79af36b0db5
BLAKE2b-256 a970a5c13fd1c6ccbf25f90818a430dd1fb4a7101499aa4f3f6a6e8109ad2017

See more details on using hashes here.

File details

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

File metadata

  • Download URL: schema_first-0.14.7-py3-none-any.whl
  • Upload date:
  • Size: 23.6 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.7-py3-none-any.whl
Algorithm Hash digest
SHA256 aad95dbdf8f8481be67a7703ab029acb9dbd487ea0811da01235ed92a7cbced1
MD5 4afb4da771b21c7c5eea957b8973a30f
BLAKE2b-256 fdeacb52373289d10f85b77fa2d4b42ba386639e331d6673f149b05764526cd7

See more details on using hashes here.

Release history Release notifications | RSS feed

0.16.5

2 files

0.16.4

2 files

0.16.3

2 files

0.16.2

2 files

0.16.1

2 files

0.16.0

2 files

0.15.2

2 files

0.15.1

2 files

0.15.0

2 files

0.14.8

2 files

This release

0.14.7 This release

2 files

0.14.6

2 files

0.14.5

2 files

0.14.4

2 files

0.14.3

2 files

0.14.2

2 files

0.14.1

2 files

0.14.0

2 files

0.11.1

2 files

0.11.0

2 files

0.6.1

1 file

0.6.0

1 file

0.5.0

2 files

0.4.0

2 files

0.3.0

2 files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page