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.15.0.tar.gz
(16.4 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.15.0.tar.gz.
File metadata
- Download URL: schema_first-0.15.0.tar.gz
- Upload date:
- Size: 16.4 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via:
twine/6.2.0 CPython/3.14.6
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
b4c97ffefae074be431eeedf7bdde7e0c0482d76b73162ab4629b3e2c177171e
|
|
| MD5 |
8e334e98ffe610a69322ac36b90f4c2a
|
|
| BLAKE2b-256 |
f9d0ac13d7052fca6d6d916c226c9eceae62a3090e9f59fd4d69ec37febb8279
|
File details
Details for the file schema_first-0.15.0-py3-none-any.whl.
File metadata
- Download URL: schema_first-0.15.0-py3-none-any.whl
- Upload date:
- Size: 25.6 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 |
e5b317441a9d8cfb71b08d22ec8f9e02944cb9267817cc7300955c2df4568333
|
|
| MD5 |
969fd95347bbc1a28d55748721270ba9
|
|
| BLAKE2b-256 |
a50299e7beff22ae50df75164b24b96e0442483ebcd376958ab58f63399ce36e
|
