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.4.tar.gz
(16.9 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.4.tar.gz.
File metadata
- Download URL: schema_first-0.16.4.tar.gz
- Upload date:
- Size: 16.9 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via:
twine/6.2.0 CPython/3.14.6
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
7924bb7a94c1a7b9fa70d34239017f46a7141632c0169c4c9a19f2c022136dd2
|
|
| MD5 |
f0b3825ed6d4ccd4297877ee663e1f57
|
|
| BLAKE2b-256 |
10478a0b9bac8e61392e51153f60de342e77cdde694b6d73093032913d6ff3fa
|
File details
Details for the file schema_first-0.16.4-py3-none-any.whl.
File metadata
- Download URL: schema_first-0.16.4-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 |
673866e2a96fecac3c1f39107276a7c9c61f1688c9795899307c5d8869cbffa2
|
|
| MD5 |
6027a7bf10efadd2c30e28c4c6801da4
|
|
| BLAKE2b-256 |
5feb52000f613c35459769af3fb35ad03cdd42a6a7cb07a8e5392e90a62e3ef4
|
