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
1 maintainer
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.8.tar.gz
(14.6 kB
view details)
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file schema_first-0.14.8.tar.gz.
File metadata
- Download URL: schema_first-0.14.8.tar.gz
- Upload date:
- Size: 14.6 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via:
twine/6.2.0 CPython/3.14.6
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
8dbae609810f9dfe62377d3cdb1cd3dd481346fbec7f337fff5ef6fdaa1d211d
|
|
| MD5 |
68ffd6352aa881c7cbeb99ceb1f7b865
|
|
| BLAKE2b-256 |
b151e14025aaefb8b1edde44e645140473ed84ac896bc0f0fad4b804424a3403
|
File details
Details for the file schema_first-0.14.8-py3-none-any.whl.
File metadata
- Download URL: schema_first-0.14.8-py3-none-any.whl
- Upload date:
- Size: 23.7 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via:
twine/6.2.0 CPython/3.14.6
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
1a5e7db9efc31f35f376802558a27a5c28f2382ee84b3cc16480243bde8f1833
|
|
| MD5 |
d4f7beeebe2d6cb76b4142c78e526735
|
|
| BLAKE2b-256 |
7f30f4c2dd1927ef56786f9273d47b059ba66cef2df607d5614ed0aca364c516
|
