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.6.tar.gz
(14.5 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.6.tar.gz.
File metadata
- Download URL: schema_first-0.14.6.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
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
ad03954354c34da24cf8655b717d3796e79d76e41475acc7676c212828a1746c
|
|
| MD5 |
a374df86f2302ffafac81a95c5c02f87
|
|
| BLAKE2b-256 |
d5e4bd14031d580f15c58873fb37e1d77d6ab276c6d9ce25aa14ce802c08ac18
|
File details
Details for the file schema_first-0.14.6-py3-none-any.whl.
File metadata
- Download URL: schema_first-0.14.6-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
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
7e145e70b875925e983320c502da6d297aa5467bf5c60deae915fc8b9822514f
|
|
| MD5 |
b0ab8c322bdfceaa2d19f9e2c2c45949
|
|
| BLAKE2b-256 |
cfff8fd82f5c8cb7a8ce77c22db39d586e220c1fb75ab0917550cbff5d41d29c
|