PgArachne Explorer

1 хв читання

PgArachne Explorer

Explorer — це потужний веб-інтерфейс, що входить до каталогу tools/pgarachne-explorer. Це не просто інструмент документації — це повністю функціональний демонстраційний застосунок, побудований на HTML/JS, який спілкується з базою даних виключно через PgArachne. Хостована версія також доступна на explorer.pgarachne.com.

Що він уміє?

  • Огляд API: Він читає функцію capabilities, щоб відобразити всі доступні ендпоінти та їхні параметри.
  • Живе тестування: Ви можете виконувати функції безпосередньо з браузера.
  • Автоматична документація: Він перетворює SQL-коментарі (включно з метаданими --- PARAMS ---) на читабельну документацію.
  • Сучасний інтерфейс: Підтримує темний/світлий режим і може бути встановлений як PWA на мобільних пристроях.
  • Автентифікація: Вкладка Password використовує HTTP Basic Auth для прямого підключення як користувач бази даних — GRANT … TO pgarachne не потрібен. Вкладка API Token приймає JWT або довгостроковий API-токен, надісланий як Bearer.

Параметри URL:

Ви можете попередньо заповнити налаштування з’єднання за допомогою параметра ?url=, наприклад: ?url=http://localhost:8080/db/my_database. Це автоматично розділить URL на поля API Host, Prefix і Database.

Як увімкнути: Встановіть змінну середовища STATIC_FILES_PATH, щоб вона вказувала на каталог tools/pgarachne-explorer на вашому диску. Потім відвідайте http://localhost:8080.