http://mikrotik.moscow Новое в теме Схема REST API для Postman и не только форума RouterOS на сайте Mikrotik.moscow [mikrotik.moscow] ru http://backend.userland.com/rss2 Tue, 26 May 2026 03:12:11 +0300 Схема REST API для Postman и не только RouterOS в форуме RouterOS.
Спасибо! Недавно я создал «генератор кода» для Postman, который преобразует JSON-запрос Postman в правильный /tool/fetch. Я всё ещё работаю над этим, и Postman должен принять это. Но этот проект позволит создавать «фрагменты кода» RouterOS /tool/fetch прямо из приложения Postman (и других инструментов).

Обновление на июль 2025: curl2rsc больше не работает из-за закрытия glitch.com. Но я добавил веб-страницу, которая использует RouterOS Postman «codegen» для преобразования команды curl в команду RouterOS /tool/fetch, как часть серии «Scheme Tools» здесь.  
Сайт для преобразования команды cURL в команду /tool/fetch

Примечания:  
_- URL может измениться в будущем, но сейчас он здесь.  
Если никто долго не заходил на сайт, может понадобиться около 15 секунд, чтобы «прогреться», так как я использую бесплатный backend glitch.com. Перезагрузка страницы тоже может помочь._

Случай использования: Обычно SaaS/облачные и подобные сайты дают какой-то пример curl в доках или интерфейсе, так что вышеописанный инструмент позволяет просто скопировать этот «curl» и получить, надеюсь, корректную команду /tool/fetch для использования. Внутри он преобразует curl в JSON-объект Postman, а мой RouterOS codegen конвертирует JSON в /tool/fetch (в меру возможностей fetch) и в несколько вариантов для удобного копирования в RouterOS.

Попробуйте преобразовать какой-нибудь curl -X GET example.com и напишите мне здесь или на GitHub, если что-то конвертируется неправильно.
17.07.2025 01:30:00, Amm0.]]> http://mikrotik.moscow/forum/forum57/86646-skhema-rest-api-dlya-postman-i-ne-tolko/message408936 http://mikrotik.moscow/forum/forum57/86646-skhema-rest-api-dlya-postman-i-ne-tolko/message408936 Thu, 17 Jul 2025 01:30:00 +0300 RouterOS Схема REST API для Postman и не только RouterOS в форуме RouterOS.
Только что зарегистрировался, чтобы сказать спасибо за то, что поделились этим!
28.09.2024 09:47:00, EBRAddict.]]> http://mikrotik.moscow/forum/forum57/86646-skhema-rest-api-dlya-postman-i-ne-tolko/message408935 http://mikrotik.moscow/forum/forum57/86646-skhema-rest-api-dlya-postman-i-ne-tolko/message408935 Sat, 28 Sep 2024 09:47:00 +0300 RouterOS Схема REST API для Postman и не только RouterOS в форуме RouterOS.
Я добавил интерфейс отображения различий на страницу загрузки схемы на GitHub, https://tikoci.github.io/restraml. Теперь там показываются команды и атрибуты, которые изменились между версиями RouterOS:
24.05.2024 15:20:00, Amm0.]]> http://mikrotik.moscow/forum/forum57/86646-skhema-rest-api-dlya-postman-i-ne-tolko/message408934 http://mikrotik.moscow/forum/forum57/86646-skhema-rest-api-dlya-postman-i-ne-tolko/message408934 Fri, 24 May 2024 15:20:00 +0300 RouterOS Схема REST API для Postman и не только RouterOS в форуме RouterOS.
Я автоматизировал создание схем на GitHub и добавил новую страницу загрузок, где можно посмотреть схемы/документы для разных версий с 7.9 по 7.15rc4:  
Downloads: https://tikoci.github.io/restraml  

Исходники и другие детали здесь:  
GitHub Project: https://github.com/tikoci/restraml  
VSCode Online View: https://github.dev/tikoci/restraml  

Гиковские подробности... Внутренности этой автоматизации довольно интересные (на мой взгляд) и, скорее всего, полезные для других автоматизаций с использованием GitHub и RouterOS. В частности, GitHub Action, который собирает схемы/документы и так далее, запускает CHR внутри самого GitHub, который используется для выполнения необходимых REST-запросов к /console/inspect.  

В проекте на GitHub, а именно в разделе «Actions», можно увидеть все детали процесса генерации схем, где основную работу выполняет файл manual-docker-in-docker.yaml.  

И правда, когда я начинал этот мини-проект, я всего лишь хотел «продеффать» дерево команд, чтобы увидеть, что изменилось в CLI между версиями. И в итоге понадобилось как-то запустить Docker^2 + QEMU + CHR...
22.05.2024 19:45:00, Amm0.]]> http://mikrotik.moscow/forum/forum57/86646-skhema-rest-api-dlya-postman-i-ne-tolko/message408933 http://mikrotik.moscow/forum/forum57/86646-skhema-rest-api-dlya-postman-i-ne-tolko/message408933 Wed, 22 May 2024 19:45:00 +0300 RouterOS Схема REST API для Postman и не только RouterOS в форуме RouterOS.
Было бы здорово, если бы MikroTik просто опубликовали спецификацию, вместо того чтобы заставлять делать всю тяжёлую работу самим. Я умолял их не использовать собственный REST API, а взять за основу общепринятый стандарт YANG. Тогда конфигурацию роутера можно было бы создавать и хранить в нейтральном формате, понятном для любого производителя, и преобразовывать в что-то, что понимает RouterOS. Очень жаль, что они отказались. Твоё решение здесь меня немного утешает, и за это я очень благодарен. Если нужна помощь — техническая документация, настройка тестов и так далее — пиши мне на GitHub https://github.com/brotherdust
14.12.2023 21:04:00, brotherdust.]]> http://mikrotik.moscow/forum/forum57/86646-skhema-rest-api-dlya-postman-i-ne-tolko/message408932 http://mikrotik.moscow/forum/forum57/86646-skhema-rest-api-dlya-postman-i-ne-tolko/message408932 Thu, 14 Dec 2023 21:04:00 +0300 RouterOS Схема REST API для Postman и не только RouterOS в форуме RouterOS.
Хотя это не «скрипт», у меня есть реализация на JavaScript, которая через /system/console по REST генерирует RAML 1.0 схему. Просто раньше я это здесь не выкладывал, вот теперь делюсь. Это не идеально, скорее около 90%. Например, особенно с аргументами — как и у ChatGPT, может допускать пару ошибок, но в основном всё работает, особенно POST-запросы. В большинстве случаев по типам не придирается — почти все помечены как «any». Есть баги в /console/inspect при использовании request=syntax — некоторые падают, поэтому синтаксических данных мало используется. Есть все пакеты, кроме calea, возврат атрибутов «неточный» — просто отмечен как «any». JSON-аргументы в основном списки (возможно, не всегда), но типы по-прежнему «any». Поскольку схема генерируется автоматически, в ней нет «примеров» или «документации», только эндпоинты и аргументы. GET-запросы не полностью описаны для корневых команд (GET /ip/address) — там должны быть указаны query-параметры и вывод в виде массива. Некоторые настройки по умолчанию для Postman можно улучшить, но не очень понятно, как это контролировать через RAML… Наверняка есть и другие недостатки… В любом случае — хороший старт для более формализованной схемы. Хотя это и не OpenAPI/swagger напрямую, RAML отлично импортируется в Postman.

RAML-схема для скачивания  
Сгенерированную RAML-схему для импорта (~6 МБ, 250 тысяч строк YAML) можно скачать по ссылке: https://tikoci.github.io/restraml  
Проверяйте сайт на наличие новых версий. Более свежие версии лежат в GitHub-проекте, но оригинальные файлы по состоянию на момент этого поста остались тут:  
7.12 — https://tikoci.github.io/restraml/routeros.raml  
7.13 — https://tikoci.github.io/restraml/routeros.7.13.raml

Использование Postman… (и других HTTP-инструментов)  
Чтобы использовать в Postman:  
- Перейдите в секцию API  
- Нажмите кнопку «Import» вверху секции API  
- Загрузите RAML-файл из вышеуказанных ссылок  
- Нажмите «View import setting» и выберите «Schema», а не стандартный «example» в качестве источника для данных запросов/ответов Postman  
- Нажмите иконку назад в левом верхнем углу, затем «Import»  
- Подождите (Postman показывает прогресс в статус-баре)  
- Перейдите в секцию «Collections» слева, увидите новый RouterOS

Работать с Postman дальше — дело пользователя. По крайней мере, нужно добавить:  
- «Basic Auth» должен быть настроен либо на коллекцию, либо другой уровень  
- {{baseUrl}} надо задать IP вашего роутера через переменные окружения в Postman

Конвертация RAML в OpenAPI/swagger  
Этот сайт вроде позволяет взять RAML-схему и получить из неё OpenAPI:  
https://mulesoft.github.io/oas-raml-converter/  
Сгенерированная OpenAPI-схема:  
https://tikoci.github.io/restraml/routeros-openapi3.json  
Хотя я мало тестировал, по крайней мере в Postman она загружается. Наверняка есть другие CLI-инструменты для этого, но главное, что Postman поддерживает RAML — это было важно.

JavaScript для генерации RAML  
В основном для справки. Генерация занимает около 30 минут и выполняет свыше 30 тысяч REST-запросов на мощном MacBook. Исходники JS доступны в GitHub-проекте:  
https://github.com/tikoci/restraml  
Код не изящный, но работает. Пока не обернул в контейнер, если времени хватит — займусь позже.  
P.S. Можно было написать RouterOS скрипт, но 4К кусков по 6 МБ звучит не очень весело — хотя RSC-скрипт или контейнер теоретически тоже подойдут. JS-шный способ был проще и быстрее, так как большую часть работы я уже сделал раньше.

Postman в VSCode с RouterOS REST…  
Использование расширения Postman для VSCode тоже работает, как только схема загружена:  
Включая генерацию кода Postman из REST-схемы.

Правки:  
- Добавил TODO  
- Исправил ссылки, чтобы использовать GitHub-проект вместо гита для скачивания RAML-схемы  
- Добавил скриншот VSCode с плагином Postman  
- Обновил URL для генерации OpenAPI схемы  
- Обновил ссылки на GitHub-проект.
11.09.2023 03:20:00, Amm0.]]> http://mikrotik.moscow/forum/forum57/86646-skhema-rest-api-dlya-postman-i-ne-tolko/message408931 http://mikrotik.moscow/forum/forum57/86646-skhema-rest-api-dlya-postman-i-ne-tolko/message408931 Mon, 11 Sep 2023 03:20:00 +0300 RouterOS