Сеть и диагностика

Проверить JSON API и обязательные поля

Запрашивает API, проверяет JSON, путь до данных и наличие нужных ключей.

Python Windows macOS Linux Средний
Скачать json_api_check.py
Описание

Что делает скрипт

Скрипт выполняет GET с заголовком Accept: application/json, проверяет код ответа и разбирает тело. Можно указать путь через точку и список обязательных ключей, в том числе для массива объектов. При ошибке разбора или отсутствии поля возвращается ненулевой код.

Запуск

Быстрый старт

python json_api_check.py http://127.0.0.1:8080/api/items

Скачайте файл, откройте терминал в папке со скриптом и выполните команду. В Linux и macOS интерпретатор может называться python3, в Windows - python или py.

Примеры

Другие варианты

  • python json_api_check.py http://127.0.0.1:8080/api/items
  • python json_api_check.py http://127.0.0.1:8080/api/items --path data.items --require id,name
  • python json_api_check.py http://127.0.0.1:8080/api/items --header 'X-Demo: 1'
Зависимости

Что понадобится

Python 3.10+ Только стандартная библиотека
Windows winget install Python.Python.3.12
macOS brew install python
Linux sudo apt install python3
Исходник

json_api_check.py

#!/usr/bin/env python3
"""Проверка JSON API, пути до данных и обязательных ключей."""
from __future__ import annotations

import argparse
import json
import sys
import time
import urllib.error
import urllib.request
from urllib.parse import urlsplit

MAX_BODY = 5 * 1024 * 1024


def get_path(data: object, path: str) -> object:
    current = data
    for part in path.split("."):
        if isinstance(current, list):
            try:
                index = int(part)
            except ValueError as error:
                raise KeyError(f"для массива нужен индекс, получено {part}") from error
            try:
                current = current[index]
            except IndexError as error:
                raise KeyError(f"индекс {index} вне массива") from error
        elif isinstance(current, dict):
            if part not in current:
                raise KeyError(f"нет ключа {part}")
            current = current[part]
        else:
            raise KeyError(f"на пути встретилось значение без ключей: {part}")
    return current


def main() -> int:
    parser = argparse.ArgumentParser(description="Проверить JSON API")
    parser.add_argument("url", help="URL JSON API")
    parser.add_argument("--timeout", type=float, default=10.0, help="Таймаут запроса")
    parser.add_argument("--path", default="", help="Путь до данных, например data.items")
    parser.add_argument("--require", default="", help="Обязательные ключи через запятую")
    parser.add_argument("--expect-status", type=int, default=200, help="Ожидаемый HTTP-код")
    parser.add_argument("--header", action="append", default=[], help="Дополнительный заголовок Name: value")
    args = parser.parse_args()

    parts = urlsplit(args.url)
    if parts.scheme not in {"http", "https"} or not parts.hostname:
        parser.error("Нужен HTTP или HTTPS URL")

    headers = {"Accept": "application/json"}
    for raw_header in args.header:
        if ":" not in raw_header:
            parser.error("Заголовок должен иметь вид Name: value")
        name, value = raw_header.split(":", 1)
        headers[name.strip()] = value.strip()

    request = urllib.request.Request(args.url, headers=headers)
    started = time.perf_counter()
    try:
        with urllib.request.urlopen(request, timeout=args.timeout) as response:
            status = response.status
            content_type = response.headers.get("Content-Type", "")
            body = response.read(MAX_BODY + 1)
    except urllib.error.HTTPError as error:
        print(f"HTTP {error.code}: {error.reason}", file=sys.stderr)
        return 1
    except (urllib.error.URLError, TimeoutError, OSError) as error:
        print(f"Ошибка запроса: {error}", file=sys.stderr)
        return 1
    elapsed = time.perf_counter() - started

    if status != args.expect_status:
        print(f"Неожиданный статус: {status}, ожидался {args.expect_status}", file=sys.stderr)
        return 1
    if len(body) > MAX_BODY:
        print("Ответ больше 5 МБ, проверка остановлена", file=sys.stderr)
        return 1
    try:
        data = json.loads(body)
    except json.JSONDecodeError as error:
        print(f"Ответ не является JSON: {error}", file=sys.stderr)
        return 1

    target = get_path(data, args.path) if args.path else data
    print(f"URL: {args.url}")
    print(f"HTTP: {status}, тип: {content_type or 'не указан'}, время: {elapsed:.3f} с")
    print(f"Корень: {type(data).__name__}")
    if isinstance(data, dict):
        print(f"Ключи: {', '.join(sorted(data)) or 'нет'}")
    if args.path:
        print(f"Путь: {args.path}, тип: {type(target).__name__}")
    if isinstance(target, list):
        print(f"Элементов: {len(target)}")

    required = [item.strip() for item in args.require.split(",") if item.strip()]
    missing: list[str] = []
    if required:
        if isinstance(target, dict):
            missing = [key for key in required if key not in target]
        elif isinstance(target, list):
            for index, item in enumerate(target):
                if not isinstance(item, dict):
                    missing.append(f"[{index}] не объект")
                    continue
                for key in required:
                    if key not in item:
                        missing.append(f"[{index}].{key}")
        else:
            missing = ["значение не является объектом или массивом"]

    if missing:
        print("Отсутствуют обязательные ключи:", file=sys.stderr)
        for item in missing:
            print(f"  {item}", file=sys.stderr)
        return 1
    print("Проверка пройдена")
    return 0


if __name__ == "__main__":
    raise SystemExit(main())

Скрипты работают с файлами и настройками системы. Перед запуском прочитайте код и проверьте пути. Особенно если скрипт удаляет, перезаписывает или перемещает данные.

CLI 1.0.0

Скачать без браузера

Команда скачает этот файл в текущую папку. CLI работает на Windows, macOS и Linux.

scriptdock get network-json-api
  • Поиск по всему каталогу
  • Python 3.10+
  • Без внешних пакетов
Скачать CLI

GUI-версия готовится. Подробнее

Категория

Сеть и диагностика

Проверка соединений, DNS, портов, скорости и сетевых настроек.