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.12 and newer.
Install and update using pip:
$ pip install -U schema_first
Example
Create specification - openapi.yaml:
openapi: 3.2.0
info:
title: Example API for testing Schema-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.16.2.tar.gz
(16.8 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.16.2.tar.gz.
File metadata
- Download URL: schema_first-0.16.2.tar.gz
- Upload date:
- Size: 16.8 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via:
twine/6.2.0 CPython/3.14.6
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
fcc7db21a86d70b84d1fe068ad55cd456749434dc89d9e726f2e58f1852bfd9d
|
|
| MD5 |
3c5ae5eb6dd90688a28c3bc724286f0a
|
|
| BLAKE2b-256 |
fd51fc167018dc4e69414e9d0621ab196308059e426f0a9e382ca104abc1cde4
|
File details
Details for the file schema_first-0.16.2-py3-none-any.whl.
File metadata
- Download URL: schema_first-0.16.2-py3-none-any.whl
- Upload date:
- Size: 25.0 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 |
9c31a6c7fbbcf9681bfa305df8fbc30797b1577db8101022dafc2d44a3edcff0
|
|
| MD5 |
b2fd8987b0db3622575373992319ce45
|
|
| BLAKE2b-256 |
6cdee477eac7828958d3c83996389282e6ecb908258ffee3a129b1fcf4ce3b7e
|
