OpenAPI / Swagger Formatter

Format and validate OpenAPI / Swagger specs (JSON or YAML) and count paths and operations.

Это локальный инструмент: он работает целиком в вашем браузере. Вставленная спецификация OpenAPI или Swagger никогда не покидает ваше устройство — ничего не загружается в ArrayKit или на любой сервер.

Преобразовать между YAML и JSON

Об инструменте OpenAPI / Swagger Formatter

Форматтер OpenAPI от ArrayKit форматирует и проверяет спецификации OpenAPI и Swagger в JSON или YAML, всё внутри вашего браузера. Вставьте спецификацию, и инструмент разберёт документ, сообщит обнаруженную версию (OpenAPI 3.x или Swagger 2.0), название API и подсчитает, сколько путей и операций он определяет, а затем заново выведет чистый, единообразно отформатированный JSON или YAML. Он создан для бэкенд- и API-разработчиков, технических писателей и платформенных команд, которым нужен быстрый способ привести в порядок отредактированный вручную контракт, преобразовать между JSON и YAML или проверить спецификацию перед коммитом или передачей в Swagger UI, генераторы кода или шлюз. Поскольку сборка запроса и разбор происходят локально, вы можете форматировать внутренние или неопубликованные определения API, не отправляя их на сервер. Используйте его, чтобы отловить некорректный YAML, подтвердить число операций и стандартизировать форматирование по всему репозиторию.

Возможности

Как использовать OpenAPI / Swagger Formatter

  1. Вставьте свою спецификацию OpenAPI или Swagger (JSON или YAML) в панель ввода
  2. Выберите формат вывода переключателем JSON / YAML на панели инструментов
  3. Прочитайте сводную плашку с версией, названием, числом путей и числом операций
  4. Скопируйте отформатированную спецификацию или скачайте её как 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'.

Частые ошибки и устранение неполадок

Часто задаваемые вопросы

Что такое форматтер 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 в зависимости от выбранного формата вывода.

Связанные инструменты

Все инструменты ArrayKit