CheckcraftSwagger Editor онлайн: как открыть и проверить спецификацию OpenAPI
Checkcraft — программа для проверки API и логов без кода, есть бесплатная версия. Скачать без регистрации →
Swagger Editor проверяет спецификацию OpenAPI и показывает документацию по ней прямо в браузере. Ниже — как им пользоваться и что делать дальше, когда спецификация готова.
Где открыть
Официальный онлайн-редактор находится по адресу editor.swagger.io. Вставьте YAML или JSON спецификации в левую часть или загрузите файл через меню File. Справа появится документация, а ошибки проверки будут показаны над ней со ссылкой на строку.
Если спецификация закрытая
Генерация клиента и сервера из меню отправляет спецификацию на внешний сервис. Для внутренних API безопаснее запустить редактор у себя, например в Docker, и открыть его в браузере на localhost.
docker run -p 8080:8080 swaggerapi/swagger-editorОшибки проверки
Чаще всего это отступы в YAML, ссылка $ref на несуществующую схему, обязательное поле без описания в properties и пример example, который не соответствует своей схеме. Исправляйте сверху вниз: одна ошибка в отступах порождает каскад следующих.
От спецификации к проверкам
Спецификация описывает, каким должен быть API, но не проверяет, что он таким остался. В Checkcraft спецификацию OpenAPI можно импортировать: из неё появятся запросы, к которым добавляются правила на ответ. Отдельный ответ можно сверить со схемой из спецификации на странице проверки по JSON Schema.
Повторите это на своём API
Checkcraft — настольная программа: сохраняет проверки ответа API без кода и показывает, что не совпало. Начните с учебного примера, затем подставьте свои обезличенные данные. Free работает на Windows и Linux без ограничения срока.
Скачать FreeКак получить и запустить приложениеСкачивание без регистрации и почты, архив готов за пару минут. Состав бесплатной версии опубликован на странице тарифов.
Документация
Начните с примера по ссылкам и сопоставьте результат с требованием своей проверки.