Перейти до змісту

Генерація скриптів за допомогою ШІ➧

Опис API у форматі OpenAPI машиночитний, тож його зручно віддати ШІ-асистенту (Claude, ChatGPT тощо), щоб той згенерував готовий скрипт під вашу задачу — без ручного читання всієї специфікації.

Крок 1. Отримайте опис API➧

Завантажте специфікацію з вашого сервера:

curl -s https://demo.wildcore.tools/swagger/openapi.yaml -o openapi.yaml

Файл великий (десятки методів). Якщо асистент має обмеження на розмір контексту — вирізайте лише потрібний розділ: відкрийте Swagger, знайдіть потрібні методи (групи описано на сторінці Групи та розділи API) і скопіюйте лише їх.

Крок 2. Дайте асистенту контекст➧

Щоб скрипт одразу запрацював, у запиті завжди вказуйте три речі:

  1. Базову адресу — методи живуть за префіксом https://<ваш-сервер>/api/v1.
  2. Авторизацію — заголовок X-Auth-Key: <токен> (див. Авторизація).
  3. Формат відповіді — корисні дані в полі data, обгортка {statusCode, meta, data}.

Крок 3. Сформулюйте задачу➧

Приклад запиту до ШІ:

Ось фрагмент OpenAPI-специфікації Wildcore DMS (додаю файл openapi.yaml). Базова адреса — https://wildcore.example.com/api/v1, авторизація — заголовком X-Auth-Key. Напиши Python-скрипт, який: 1) бере всі пристрої (GET /device); 2) для кожного пристрою типу OLT отримує перелік незареєстрованих ONU; 3) виводить результат у CSV. Токен читай зі змінної середовища WC_KEY, додай обробку помилок і пагінацію.

ШІ поверне готовий скрипт; за потреби попросіть переписати іншою мовою (bash/PHP/JS) або додати логіку.

Поради для якісного результату➧

  • Звужуйте контекст. Передавайте лише ті методи, що потрібні задачі, — відповідь буде точнішою, а ризик «вигадування» неіснуючих полів меншим.
  • Просіть звірятися зі схемою. Додайте: «використовуй лише поля, що є в специфікації».
  • Просіть параметризацію. Токен і адресу — через змінні середовища, а не «зашиті» в коді.
  • Ітеруйте на помилках. Якщо скрипт повертає помилку — вставте відповідь сервера (поле з кодом і текстом) назад в асистента й попросіть виправити.
  • Перевіряйте на безпечних даних. Спершу ганяйте скрипт на тестовому/демо-сервері (demo.wildcore.tools, admin/admin), а вже потім — на робочому.

Безпека➧

  • Не вставляйте реальний токен у переписку з ШІ — лише плейсхолдер; справжній ключ тримайте у змінній середовища чи секрет-сторі.
  • Видавайте для інтеграцій окремого користувача з потрібними правами й ключем з обмеженим терміном дії — так простіше відкликати доступ.
  • Згенерований код перечитуйте перед запуском, особливо методи, що змінюють дані (POST/PUT/DELETE).