Реклама мешает? Идти Без рекламы Сегодня 

Валидатор OpenAPI / Swagger Spec

ДанныеРазработчик

РЕКЛАМА · УДАЛЯТЬ?

ВХОД

Автоматический процесс

ВЫХОД

Клиентская сторона

РЕКЛАМА · УДАЛЯТЬ?

Гид

Валидатор спецификаций OpenAPI / Swagger

Валидатор OpenAPI / Swagger Spec

Мгновенно проверяйте свои спецификации OpenAPI 3.0, 3.1 или Swagger 2.0. Вставьте YAML или JSON, получите структурированный список ошибок и предупреждений с путями JSON Pointer и отформатируйте свою спецификацию для чистой документации.

Как использовать

Вставьте свою спецификацию OpenAPI или Swagger в поле ввода. Валидатор автоматически определяет, является ли она YAML или JSON, и какую версию спецификации вы используете. Результаты показывают сводку конечных точек, схем, ошибок и предупреждений. Каждая проблема включает путь JSON Pointer, чтобы вы могли быстро найти проблему.

Функции

Поддержка нескольких версий – Проверяет спецификации Swagger 2.0, OpenAPI 3.0.x и OpenAPI 3.1.x
Структурная валидация – Проверяет обязательные поля (info, paths, version), правильные типы и структуру схемы
Семантическая валидация – Обнаруживает дублирующиеся operationIds, недопустимые HTTP-методы, поврежденные ссылки $ref и несоответствия параметров пути
Пути ошибок – Каждая проблема включает путь JSON Pointer для точного определения местоположения
Красивая печать – Переформатируйте свою спецификацию как чистый JSON или YAML с правильными отступами
Сводка по спецификации – Мгновенный обзор: версия, общее количество конечных точек, схем, ошибок и предупреждений
Клиентская сторона 100% – Ваши спецификации API никогда не покинут ваш браузер

РЕКЛАМА · УДАЛЯТЬ?

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

В чем разница между Swagger 2.0 и OpenAPI 3.0?

Swagger 2.0 — это исходный формат спецификации API, разработанный SmartBear. Когда спецификация была передана в OpenAPI Initiative в 2015 году, она была переименована в OpenAPI. Версия 3.0 внесла значительные улучшения, включая лучшую поддержку обратных вызовов, ссылок, нескольких серверов и более чистую структуру компонентов. Два формата несовместимы напрямую.
Почему operationIds должны быть уникальными в спецификации OpenAPI?

operationIds служат уникальными идентификаторами для каждой операции API. Генераторы кода используют их для создания имен методов в клиентских SDK, инструменты документации используют их для якорных ссылок, а фреймворки тестирования используют их для ссылки на конкретные конечные точки. Дублирующиеся operationIds вызывают конфликты во всех этих последующих инструментах.
Что такое JSON Pointer и как читать пути ошибок валидации?

JSON Pointer (RFC 6901) — это синтаксис строки для идентификации конкретного значения в документе JSON. Например, /paths/~1users/get/parameters/0 указывает на первый параметр операции GET /users. ~1 экранирует косую черту в сегменте пути. Чтение этих указателей точно показывает, где в вашей спецификации возникает ошибка валидации.
Следует ли мне писать спецификацию OpenAPI в YAML или JSON?

Оба формата полностью поддерживаются и функционально эквивалентны. YAML обычно предпочтительнее для рукописных спецификаций, поскольку он более читабелен и поддерживает комментарии. JSON лучше подходит для спецификаций, генерируемых машинами, и программной обработки. Большинство инструментов принимают любой формат, поэтому выбирайте тот, который ваша команда считает более простым в обслуживании.