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.1.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.1.tar.gz.
File metadata
- Download URL: schema_first-0.16.1.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 |
3e9dfaea5871d2297b66beb9688a8b1dbf949b7b4078b183c5a38d287451fa6f
|
|
| MD5 |
fa364cad735100574fd792ffd848af24
|
|
| BLAKE2b-256 |
81da0790a71e52df4fbb272e93d150205b2b5239ff297287514618e0b9423c15
|
File details
Details for the file schema_first-0.16.1-py3-none-any.whl.
File metadata
- Download URL: schema_first-0.16.1-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 |
2f52b4c377d3556f413a32990ef34daa2c75f0efa711466abd9c8e3686f5ddf2
|
|
| MD5 |
dbef6fe20bf416370f0e73c9f5bd9fa7
|
|
| BLAKE2b-256 |
8d05610111903b587db3653a74843fa6ee4d6bc36f22e718197a4ee6caecd899
|
