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
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.14.5.tar.gz
(14.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.14.5.tar.gz.
File metadata
- Download URL: schema_first-0.14.5.tar.gz
- Upload date:
- Size: 14.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 |
54963614deffe832901d4a290ccebc99fff9cf6db7c2bb3fa5ba1cf1c1bdf49f
|
|
| MD5 |
f070d2aab02a4833715a8d683ea15c6d
|
|
| BLAKE2b-256 |
1369d684e9dcd51f7ee1fe88a9b21a65d26e11eb5b7191c7e1ada302c188fb8a
|
File details
Details for the file schema_first-0.14.5-py3-none-any.whl.
File metadata
- Download URL: schema_first-0.14.5-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 |
fecc0f3c90652d4da7fe16b0ff52eff0ef800725da82a3b557732415c7fe0229
|
|
| MD5 |
0f2e9fc7b87d3e363f090d81de347ebf
|
|
| BLAKE2b-256 |
fc67a218f6a131c86e99667e0566a83e1221f342266cbff4512f3b58873f87a7
|
