PgArachne Explorer

1 min czytania

PgArachne Explorer

Explorer to zaawansowany interfejs webowy GUI zawarty w katalogu tools/pgarachne-explorer. Nie jest to wyłącznie narzędzie dokumentacyjne — to w pełni funkcjonalna aplikacja demonstracyjna zbudowana w HTML/JS, która komunikuje się z bazą danych wyłącznie za pośrednictwem PgArachne. Hostowana wersja jest również dostępna na explorer.pgarachne.com.

Co potrafi?

  • Inspekcja API: Odczytuje funkcję capabilities, aby wyświetlić wszystkie dostępne endpointy i ich parametry.
  • Testowanie na żywo: Możesz wykonywać funkcje bezpośrednio z przeglądarki.
  • Automatyczna dokumentacja: Renderuje komentarze SQL (w tym metadane --- PARAMS ---) do postaci czytelnej dokumentacji.
  • Nowoczesny interfejs: Wspiera tryb ciemny i jasny oraz może być zainstalowany jako PWA na urządzeniach mobilnych.
  • Uwierzytelnianie: Zakładka Password używa HTTP Basic Auth do połączenia bezpośrednio jako użytkownik bazy danych — bez potrzeby GRANT … TO pgarachne. Zakładka API Token przyjmuje JWT lub długotrwały token API wysyłany jako Bearer.

Parametry URL:

Ustawienia połączenia możesz wstępnie wypełnić za pomocą parametru ?url=, na przykład: ?url=http://localhost:8080/db/my_database. Spowoduje to automatyczny podział adresu URL na pola API Host, Prefix i Database.

Jak go włączyć: Ustaw zmienną środowiskową STATIC_FILES_PATH, tak aby wskazywała na katalog tools/pgarachne-explorer na dysku. Następnie odwiedź http://localhost:8080.