Skip to main content

Convert JSON API responses to YAML schema

Project description

JSON to YAML Schema Converter

A powerful Python tool that converts JSON API responses into YAML schema format with proper type definitions, titles, and format specifications.

Features

  • Smart Type Detection: Automatically detects and maps JSON types to schema types
  • Date-Time Recognition: Identifies datetime strings and adds format: date-time, format: epoch-millis, format: uuid, format: ip-addr, format: mac-addr, format: url, format: uri
  • Nested Object Support: Handles complex nested JSON structures
  • Array Processing: Properly processes arrays and their item types
  • Title Generation: Creates human-readable titles from JSON keys
  • CLI Interface: Easy-to-use command-line interface
  • Batch Processing: Convert multiple JSON files at once

Your api response file should look like this e.g

All json file should be build/output inside the folder or response would be like below

[
    {
        "id": 12345,
        "name": "test Innovations Corp",
        "legal_name": "Tech Innovations Corporation Inc.",
        "founded_date": "2020-01-15",
        "incorporation_date": "2020-01-15T09:00:00Z",
        "tax_id": "12-3456789",
        "website": "https://testinnovations.com",
        "industry": "Software Technology",
        "employee_count": 250,
        "annual_revenue": 15000000.75,
        "is_public": true,
        "stock_symbol": null
    },
    {
        "id": 4565,
        "name": "demo Innovations Corp",
        "legal_name": "demo Innovations Corporation Inc.",
        "founded_date": "2020-01-15",
        "incorporation_date": "2020-01-15T09:00:00Z",
        "tax_id": "12-3456789",
        "website": "https://testinnovations.com",
        "industry": "Software Technology",
        "employee_count": 250,
        "annual_revenue": 15000000.75,
        "is_public": true,
        "stock_symbol": null
    },
]

Command Line Interface (CLI)

# Use custom input folder
json2yaml_schema --folder my_api_data_folder

Python API Usage

from json_yaml_schema_converter import JSONToYAMLConverter

# Initialize converter
converter = JSONToYAMLConverter("path/to/json/files")

# Convert all JSON files
converted_files = converter.process_all_json_files()

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

json_yaml_schema_converter-0.1.1.tar.gz (10.3 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

json_yaml_schema_converter-0.1.1-py3-none-any.whl (10.4 kB view details)

Uploaded Python 3

File details

Details for the file json_yaml_schema_converter-0.1.1.tar.gz.

File metadata

File hashes

Hashes for json_yaml_schema_converter-0.1.1.tar.gz
Algorithm Hash digest
SHA256 10196cae172a7185f1ea3394c3b46ed86697d91a18e34d14cdeafe39b120b3b6
MD5 0a3fbc0e134520bd52e88154a8c2636c
BLAKE2b-256 d839d66a381bc9564087d201c102fd70722dc6145c1523196253b154cc6016e6

See more details on using hashes here.

File details

Details for the file json_yaml_schema_converter-0.1.1-py3-none-any.whl.

File metadata

File hashes

Hashes for json_yaml_schema_converter-0.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 80a9db5edb806910171ad8fdbac06db04a04e9afb3f9ee7bfc2cd56345ebca0a
MD5 46ce49efeb09ac3f7714d24e37d9d752
BLAKE2b-256 fdc1a546db9195d0e57024c2d29d4d4d01eac63f7d60b006dd50607815d89f47

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page