Seleziona la tua lingua

Web Services Documentation - Cover

Sistema completo per la documentazione delle API di Joomla. Offre interfacce interattive Swagger UI e Redoc con generazione automatica delle specifiche OpenAPI 3.1.0 partendo dai componenti installati.

Scarica v1.0.0
9 versione corrente 9 totali
Valuta sulla JED

Panoramica

Perfetto per gli sviluppatori che creano integrazioni, testano API o documentano componenti personalizzati. Dispone di navigazione gerarchica intelligente, supporto per la modalità scura e integrazione perfetta direttamente nel pannello di amministrazione di Joomla.

Doppia interfaccia

Scegli tra l'interattiva Swagger UI per test dal vivo o la pulita Redoc per una lettura professionale.

Auto-Generazione

Analizza automaticamente le rotte di Joomla e i plugin per creare specifiche dinamiche OpenAPI 3.1.0.

Autenticazione automatica

Genera e inietta in modo sicuro i token API all'interno di Swagger UI per il test immediato degli endpoint.

In sintesi

  • Esploratore API interattivo con test dal vivo.
  • Navigazione gerarchica (albero dei tag fino a 4 livelli).
  • Generatore a doppia modalità: script CLI e PHP accessibile via web.
  • Include modulo "help menu" di amministrazione per un rapido accesso.
  • Costruito per Joomla 6.0+ con WebAssetManager e standard PSR-4.

Interfacce & Strumenti

Una suite completa di strumenti integrati direttamente nella tua dashboard di Joomla.

Web Services Documentation - Swagger UI
Esploratore Swagger UI

Testa gli endpoint dal vivo direttamente dal pannello di amministrazione. Include iniezione automatica dei token ed esempi di richiesta.

Web Services Documentation - Redoc
Interfaccia Redoc

Layout pulito a tre pannelli, ottimizzato per la lettura. Include la modalità scura sincronizzata con il tema di Joomla.

Web Services Documentation - Generatore
Generatore di Specifiche

Scegli tra la generazione delle specifiche Core Statiche, solo per Plugin attivi, o per tutti i componenti installati.

Caratteristiche principali

  • Rilevamento intelligente: Scansiona e scopre automaticamente tutti gli endpoint dei componenti installati e le rotte basate sui plugin.
  • Estrazione filtri: Documenta in automatico i parametri di query e gestisce i pattern di routing complessi di Joomla.
  • Autenticazione sicura: Archiviazione sicura dei token nel database di Joomla con controlli rigorosi dei permessi in ogni fase.
  • Deduplicazione intelligente: Algoritmi avanzati evitano la definizione duplicata di parametri nelle specifiche OpenAPI generate.
  • Integrazione menu help: Include un modulo (`mod_joomlalabs_webservices_helpmenu`) per un rapido accesso dall'header di amministrazione.
  • Architettura moderna: Sviluppato utilizzando Joomla WebAssetManager, Service Providers e rigoroso namespacing PSR-4.

Tre Opzioni di Specifica

Specifica Statica

API core di Joomla pre-generate. Ideale per integrazioni standard che non dipendono da componenti di terze parti.

Generata (Plugin Attivi)

Specifica dinamica che include le API di base più eventuali endpoint esposti dai plugin attualmente abilitati.

Generata (Tutti i Componenti)

Il quadro completo. Scansiona e documenta l'intero ecosistema dei componenti Joomla installati e delle API personalizzate.

Installazione

Scarica

Ottieni il pacchetto completo (.zip) che include Componente e Modulo da GitHub.

Installa

Vai su Sistema → Installa → Estensioni e carica il file zip scaricato.

Accedi

Trovi gli strumenti nel menu Componenti → Web Services Documentation.

Requisiti
  • Joomla 6.0 o successivo.
  • PHP 8.1+ raccomandato.
  • Joomla Core API abilitate.

Nota: Per l'analisi dei componenti personalizzati, questi ultimi devono seguire le strutture standard di routing e API MVC di Joomla.