Справочник API строится из документа OpenAPI 3.0 или 3.1. Каждая попытка загрузить его — это
импорт: документ проверяется в фоне, импорт ничего не меняет, пока вы его не выберете, а выбор ничего не меняет, пока версия не опубликована. Версии и публикация описаны в разделе
.
Откройте версию, перейдите на вкладку
Импорт спецификации
и нажмите
Импортировать
. Загрузите файл или вставьте текст — JSON или YAML, UTF-8, до 5 МиБ. Импорт принимается сразу и проверяется в фоне; список обновляется сам, пока не появится отчёт.
Импорт завершается состоянием
Готов или
Ошибка. Откройте его отчёт: название, версия контракта, число операций и схем, серверы и теги, а также найденные проблемы — сначала ошибки, затем предупреждения. Что стоит знать:
- Возможно, ключ — похоже, документ содержит настоящий API-ключ. Всё содержимое контракта видно читателям, так что проверьте перед публикацией.
- Нет servers — без блока
servers справочник не покажет базовый адрес, а консоль «Попробовать» будет недоступна. - Повторяющиеся
operationId и невалидный JSON, YAML или структура OpenAPI — это ошибки: импорт не проходит. - Схемы безопасности выводятся как документация и не проверяются; вебхуки и колбэки рендерятся, но пока не как полноценная навигация; расширения
x- сохраняются, но не показываются.
Загруженный документ виден только редакторам — в отклонённой загрузке часто лежит ровно то, что публиковать нельзя.
У готового импорта нажмите
Использовать в следующей публикации
. Для читателей пока ничего не меняется: на вкладке
Публикация
эта спецификация появится в блоке «Что будет опубликовано» вместе со структурными изменениями относительно текущего контракта — операции добавлены, удалены или сменили сигнатуру. Это не отчёт о ломающих изменениях: сломает ли что-то клиента, зависит от того, как API используют. Опубликуйте версию, чтобы новый контракт вышел на сайт.
Вместо ручной загрузки вкладка
Удалённый источник
может забирать документ из Git-репозитория или по URL по расписанию. Выберите
Провайдер, укажите
URL либо
Репозиторий,
Ветку и
Путь в репозитории, а для закрытого источника —
Заголовок авторизации и
Токен доступа. Токен сохраняется и больше не показывается; при следующих сохранениях оставьте поле пустым, чтобы сохранить его.