Форматтер OpenAPI, который форматирует и проверяет спецификации Swagger и OpenAPI в JSON или YAML, подсчитывая пути и операции.
Форматтер OpenAPI
Форматтер OpenAPI, который форматирует и проверяет спецификации Swagger и OpenAPI в JSON или YAML, подсчитывая пути и операции.
Это локальный инструмент: он работает целиком в вашем браузере. Вставленная спецификация OpenAPI или Swagger никогда не покидает ваше устройство — ничего не загружается в ArrayKit или на любой сервер.
Форматтер OpenAPI от ArrayKit форматирует и проверяет спецификации OpenAPI и Swagger в JSON или YAML, всё внутри вашего браузера. Вставьте спецификацию, и инструмент разберёт документ, сообщит обнаруженную версию (OpenAPI 3.x или Swagger 2.0), название API и подсчитает, сколько путей и операций он определяет, а затем заново выведет чистый, единообразно отформатированный JSON или YAML. Он создан для бэкенд- и API-разработчиков, технических писателей и платформенных команд, которым нужен быстрый способ привести в порядок отредактированный вручную контракт, преобразовать между JSON и YAML или проверить спецификацию перед коммитом или передачей в Swagger UI, генераторы кода или шлюз. Поскольку сборка запроса и разбор происходят локально, вы можете форматировать внутренние или неопубликованные определения API, не отправляя их на сервер. Используйте его, чтобы отловить некорректный YAML, подтвердить число операций и стандартизировать форматирование по всему репозиторию.
Возможности
Принимает ввод как в JSON, так и в YAML — JSON является корректным YAML, поэтому разбирается любой
Обнаруживает и помечает версию спецификации: OpenAPI 3.x или Swagger 2.0
Сообщает название API плюс живой подсчёт путей и операций
Подсчитывает восемь HTTP-операций (get, put, post, delete, options, head, patch, trace)
Переключайте вывод между красиво отформатированным JSON и YAML с отступом в 2 пробела
Показывает ошибки разбора с исходным сообщением, когда документ некорректен
Предупреждает, когда нет поля openapi или swagger, чтобы неизвестные спецификации выделялись
Скачайте отформатированный результат как openapi.json или openapi.yaml
Как использовать Форматировщик OpenAPI / Swagger
Вставьте свою спецификацию OpenAPI или Swagger (JSON или YAML) в панель ввода
Выберите формат вывода переключателем JSON / YAML на панели инструментов
Прочитайте сводную плашку с версией, названием, числом путей и числом операций
Скопируйте отформатированную спецификацию или скачайте её как openapi.json или openapi.yaml
Пример
Ввод
openapi: 3.0.3
info: { title: Example API, version: 1.0.0 }
paths:
/users:
get: { summary: List users, responses: { '200': { description: OK } } }
post: { summary: Create user, responses: { '201': { description: Created } } }
Результат
openapi: 3.0.3
info:
title: Example API
version: 1.0.0
paths:
/users:
get:
summary: List users
responses:
'200':
description: OK
post:
summary: Create user
responses:
'201':
description: Created
Минимальная спецификация OpenAPI 3.0 — форматтер сообщает 'OpenAPI 3.0.3 · Example API · 1 path · 2 operations'.
Частые ошибки и устранение неполадок
Сводка показывает 'Unknown — no openapi/swagger field'. — Добавьте поле верхнего уровня openapi: 3.x.x (или swagger: '2.0'); без него версию нельзя обнаружить, хотя документ всё равно форматируется.
Появляется ошибка разбора YAML, часто из-за неправильных отступов или символа табуляции. — YAML чувствителен к отступам и запрещает табуляцию — замените табуляции пробелами и выровняйте ключи единообразно, затем вставьте заново.
Число операций выглядит меньше ожидаемого. — Подсчитываются только восемь стандартных HTTP-методов; вендорские расширения вроде x-amazon-apigateway-integration и записи parameters/servers операциями не являются.
'The document is empty or not an object' после вставки. — Ввод разобрался как скаляр или null — убедитесь, что вы вставили весь объект спецификации, а не одну строку или частичный фрагмент.
Часто задаваемые вопросы
Что такое форматтер OpenAPI / Swagger?
Это инструмент, который разбирает спецификацию API OpenAPI 3.x или Swagger 2.0 и заново выводит её как чистый, единообразно отформатированный JSON или YAML, сообщая версию и число путей и операций, чтобы вы могли быстро просмотреть и стандартизировать спецификацию.
Поддерживает ли он спецификации и в JSON, и в YAML?
Да. Поскольку JSON сам по себе является корректным YAML, вы можете вставить любой формат. Используйте переключатель JSON / YAML, чтобы выбрать, как выводить отформатированный результат, что также позволяет преобразовать спецификацию из одного формата в другой.
Проверяет ли он мою спецификацию полностью по схеме OpenAPI?
Он проверяет, что документ разбирается как корректно сформированный JSON или YAML, и обнаруживает версию, название, пути и операции. Он не выполняет полную проверку по JSON Schema каждого поля, поэтому не отметит отсутствующее обязательное свойство глубоко внутри операции.
Какие версии он распознаёт?
Он помечает OpenAPI 3.x по полю openapi и Swagger 2.0 по полю swagger. Любой документ без одного из этих полей форматируется, но помечается как версия неизвестная.
Загружается ли моя спецификация API куда-либо?
Нет. Разбор, проверка и форматирование выполняются целиком в вашем браузере. Вставленная спецификация никогда не покидает ваше устройство, и ничего не загружается в ArrayKit, поэтому внутренние или неопубликованные контракты API остаются конфиденциальными.
Можно ли скачать отформатированный результат?
Да. Отформатированную спецификацию можно скопировать или скачать как openapi.json или openapi.yaml в зависимости от выбранного формата вывода.