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.0.tar.gz
(16.3 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.0.tar.gz.
File metadata
- Download URL: schema_first-0.16.0.tar.gz
- Upload date:
- Size: 16.3 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via:
twine/6.2.0 CPython/3.14.6
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
a5c4e745948b373157108b29602ce4a5dba9964e6de009d25f07edbac93c62c1
|
|
| MD5 |
929a6607061ce3454d636241d6b32003
|
|
| BLAKE2b-256 |
c63af8c795ec7adb2e138399cd8c1e5241965cd31311d1d41f4079ed29361997
|
File details
Details for the file schema_first-0.16.0-py3-none-any.whl.
File metadata
- Download URL: schema_first-0.16.0-py3-none-any.whl
- Upload date:
- Size: 24.9 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 |
9803e744819e57ddf305185c36f1e67147901e8a54ef4ec8c6d276fe01780cf5
|
|
| MD5 |
bdd29f0fbc6165b521cf3ab61c188bc6
|
|
| BLAKE2b-256 |
4259196aba51052d92dbb3a50ae954808e924e3f18da8b0c895c4d71225a4f0b
|
