Загрузка...
Сгенерировать OpenAPI 3.0 JSON для REST API: методы, маршруты, параметры и ответы — бесплатно и без регистрации.
Спецификация OpenAPI описывает договор между клиентом и сервером. Для предварительной документации удобно быстро сформировать список методов и URL. В API с параметрами пути они должны находиться в секции parameters.
Впишите URL сервера и строки вида POST /orders | Создание заказа. Скачайте OpenAPI JSON, откройте в совместимом редакторе и уточните тела запросов, ошибки, авторизацию и компоненты schemas.
Результат — стартовый шаблон. Для реального сервиса нужно документировать фактические поля, ограничения, статусы HTTP, схемы ошибок и требования безопасности.
Создайте базовый OpenAPI 3.0.3 JSON из списка маршрутов. Добавляются operationId, параметры URL и шаблоны requestBody/response.
Генератор создаёт каркас спецификации, а не документирует фактическое поведение API. Схемы тела и авторизацию нужно уточнить вручную.
Заполните поля и нажмите «Сгенерировать». Файл будет создан в вашем браузере.