Stai visualizzando la documentazione di Apigee Edge.
Vai alla
documentazione di Apigee X. informazioni
Utilizza il tipo di contenuti "Base Page" di Drupal per aggiungere documentazione sulla tua API, come guide illustrative e documenti di riferimento per le API, al tuo portale Servizi per gli sviluppatori e includi contenuti come video, screencast o download di codice.
La pagina Documentazione è configurata con alcune voci iniziali organizzate in varie categorie, ad esempio "Guida introduttiva" e "Tutorial". La pagina è un punto di partenza da modificare. In questo modo puoi aggiungere le tue voci di contenuti e organizzarle nel modo che preferisci.
Aggiunta della home page Documentazione
Per impostazione predefinita, la home page della documentazione si trova all'indirizzo <siteURL>/documentation sul portale per gli sviluppatori. La home page predefinita del portale per gli sviluppatori contiene un link a questa pagina nel riquadro nella parte superiore della home page:
Puoi anche aggiungere a questa pagina un link alla documentazione nel menu principale del menu del portale per gli sviluppatori.
Tuttavia, la home page della documentazione non esiste per impostazione predefinita, quindi devi creare una nuova pagina sul portale per gli sviluppatori all'URL corretto.
Per aggiungere la home page della documentazione al portale per gli sviluppatori:
- Accedi al portale come utente con privilegi di amministratore o per la creazione di contenuti.
- Seleziona Contenuti > Aggiungi contenuti > Pagina di base nel menu di amministrazione di Drupal.
- Inserisci il titolo del documento, ad esempio la home page della documentazione, e il contenuto della prima pagina.
- Fai clic su Modifica riepilogo per aggiungere un riepilogo.
- Fai clic sulla voce Impostazioni menu sotto la sezione Corpo.
- Seleziona Fornisci un link al menu, aggiungi il titolo del link e seleziona
<Menu principale> nell'elemento principale.
Verrà aggiunto un link al menu principale della tua home page Documentazione. - Fai clic sull'elemento Impostazioni percorso URL sotto la sezione Corpo.
- Deseleziona Genera alias URL automatico e imposta l'alias URL sulla documentazione.
Per impostazione predefinita, l'URL di una pagina è <siteURL>/content/pageName. Impostando l'alias URL, imposti un URL esplicito della pagina, in questo caso <siteURL>/documentation. - Salva la pagina.
A questo punto dovresti vedere un link alla pagina nella barra dei menu e il link all'interno del riquadro della home page dovrebbe funzionare.
In qualità di amministratore, vedrai anche pulsanti di amministrazione dei contenuti, come Visualizza e Modifica. I non amministratori non potranno vederli.
Aggiunta di una pagina secondaria alla documentazione
Quando aggiungi pagine secondarie alla documentazione:
- Accedi al portale come utente con privilegi di amministratore o per la creazione di contenuti.
- Seleziona Contenuti > Aggiungi contenuti > Pagina di base nel menu di amministrazione di Drupal.
- Inserisci il titolo e i contenuti della pagina.
- Fai clic su Modifica riepilogo per aggiungere un riepilogo.
- Fai clic sulla voce Impostazioni menu sotto la sezione Corpo.
- Seleziona Fornisci un link al menu, aggiungi poi la voce di menu della home page della documentazione.
Viene aggiunta una pagina corrente come parte del menu principale della tua home page Documentazione. - Ora dovresti vedere un link alla pagina nel menu Home page Documentazione.
Modificare una pagina della documentazione
Per modificare una pagina:
- Accedi al portale come utente con privilegi di amministratore o per la creazione di contenuti.
- Vai alla pagina nel portale per gli sviluppatori.
Puoi anche fare clic su Contenuti nel menu di amministrazione di Drupal per elencare tutte le pagine e selezionarne una. - Seleziona la scheda Modifica nella pagina.
- Apri un editor visivo selezionando HTML completo o HTML filtrato nel menu a discesa Formato testo sotto la sezione Corpo.
Nell'editor dovrebbero essere visualizzati i contenuti della pagina. - Modifica la pagina in base alle esigenze.
- Fai clic su Salva.
Visualizzare qualsiasi pagina della documentazione
Per visualizzare i contenuti di un documento:
- Accedi al portale come utente con privilegi di amministratore o per la creazione di contenuti.
- Seleziona Content (Contenuti) nel menu di amministrazione di Drupal.
- Seleziona il documento da visualizzare.
Riordinare l'ordine delle pagine
Puoi modificare la sequenza e il livello di nidificazione delle pagine nel menu Home page della documentazione.
Per riordinare le pagine nel menu Home page Documentazione:
- Accedi al portale come utente con privilegi di amministratore o per la creazione di contenuti.
- Nel menu di amministrazione di Drupal, seleziona Struttura > Menu > Menu principale.
- Ogni elemento del menu è accompagnato da un'icona a sinistra del nome. Se non vedi le icone, fai clic su Nascondi ponderazioni riga.
- Per spostare un elemento, fai clic sull'icona e trascinala nella nuova posizione.
Anche il trascinamento di un elemento con elementi secondari comporta lo spostamento degli elementi secondari.
- Fai clic su Save Configuration (Salva configurazione).
Modificare le pagine a piè di pagina
Il piè di pagina del portale contiene tre icone social per Twitter, Facebook e LinkedIn e link con i seguenti URL:
- Norme sulla privacy all'URL <siteURL>/privacy-policy
- Termini e utilizzo dell'URL <siteURL>/terms-use
- Pagine di contatto all'URL <siteURL>/contact-us
Modifica queste pagine per aggiungere i tuoi contenuti.
Se queste pagine non esistono, creale:
- Accedi al portale come utente con privilegi di amministratore o per la creazione di contenuti.
- Seleziona Contenuti > Aggiungi contenuti > Pagina di base nel menu di amministrazione di Drupal.
- Inserisci il titolo del documento, ad esempio le norme sulla privacy e i contenuti della pagina.
- Fai clic su Modifica riepilogo per aggiungere un riepilogo.
- Fai clic sull'elemento Impostazioni percorso URL sotto la sezione Corpo.
- Seleziona Genera alias URL automatico e imposta l'alias URL in base alle norme sulla privacy.
Per impostazione predefinita, l'URL di una pagina è <siteURL>/content/pageName. Impostando l'alias URL, imposti un URL esplicito della pagina, in questo caso <siteURL>/privacy-policy. - Salva la pagina.
- Ripeti questa procedura per le pagine Termini e utilizzo e Contatti.
Per modificare i contenuti di una pagina a piè di pagina, ad esempio Norme sulla privacy, Termini e condizioni d'uso o la pagina Contattaci, nel portale per gli sviluppatori:
- Accedi al portale come utente con privilegi di amministratore o per la creazione di contenuti.
- Vai alla pagina facendo clic sul link nel piè di pagina. Ad esempio, fai clic sul link Norme sulla privacy.
- Fai clic sulla scheda Modifica nella pagina per aprire l'editor.
- Modifica i contenuti della pagina Norme sulla privacy in base alle esigenze.
- Fai clic su Salva.
- Ripeti questa procedura per le pagine Termini e utilizzo e Contatti.
Per modificare le icone dei social, ad esempio le icone di Twitter, Facebook e LinkedIn, nel portale per gli sviluppatori:
- Accedi al portale come utente con privilegi di amministratore o per la creazione di contenuti.
- Seleziona Struttura > Blocchi nel menu di amministrazione di Drupal.
- Scorri verso il basso nella pagina Blocchi fino a visualizzare il blocco Piè di pagina predefinito a livello di sito.
- Seleziona il link configure corrispondente al blocco Piè di pagina predefinito a livello di sito.
- Nell'area Contenuti personalizzati, fai clic con il tasto destro del mouse su un'icona di social network e seleziona Modifica link dal menu popup. In alternativa, elimina l'icona dall'area Contenuti personalizzati
per rimuoverla.
- Seleziona Salva blocco per salvare le modifiche.
Aggiunta di JavaScript alla pagina di un portale
Puoi aggiungere JavaScript a qualsiasi pagina del portale. Il modo più semplice per aggiungere JavaScript è modificare la pagina e poi:
- Seleziona HTML completo come Formato del testo.
- Seleziona il pulsante Origine per modificare il codice sorgente HTML della pagina.
- Aggiungi il tuo codice JavaScript alla pagina. Ad esempio, per visualizzare una finestra di avviso quando la pagina viene caricata,
aggiungi il seguente codice:
<script language="JavaScript">
alert('Welcome to my page!');
</script>
Alcune considerazioni sull'utilizzo di JavaScript:
- Se hai intenzione di fare riferimento a un file JavaScript, non farlo nel codice sorgente di un nodo perché questo crea un link statico. Utilizza invece il codice PHP per creare un link dinamico. In questo modo, se la posizione del file JavaScript cambia, non è necessario aggiornare tutte le pagine del portale che fanno riferimento al file.
- Se vuoi includere un file JavaScript, aggiungilo al tema del portale. Oppure, se fa parte di un modulo Drupal, aggiungilo al modulo.
- Puoi anche utilizzare la funzione drupal_add_js di Drupal per aggiungere JavaScript in Drupal. Per ulteriori informazioni, visita la pagina https://api.drupal.org/api/drupal/includes!common.inc/function/drupal_add_js/7.
Verificare la presenza di link inaccessibili
È buona norma verificare l'eventuale presenza di link inaccessibili all'interno dei tuoi contenuti. Per impostazione predefinita, il portale per gli sviluppatori è configurato per controllare l'eventuale presenza di link inaccessibili su vari tipi di pagine. Ad esempio, i link vengono controllati in pagine di base, articoli, voci di blog e argomenti dei forum.
Per aggiungere o rimuovere tipi di pagina dal controllo dei link:
- Nel menu di amministrazione di Drupal, seleziona Moduli e assicurati che il modulo Controllo link sia abilitato.
- Nel menu di amministrazione di Drupal, seleziona Configurazione > Creazione di contenuti > Controllo link.
- Configura i tipi di contenuti di cui eseguire la scansione per rilevare eventuali link inaccessibili.
Configurazione della ricerca
Il portale per gli sviluppatori fornisce un motore di ricerca integrato implementato da Apache Solr, che utilizza la libreria di ricerca Apache Lucene. Si tratta del motore di ricerca del sito stesso, a cui l'utente accede tramite la casella di ricerca nell'angolo in alto a destra di tutte le pagine del portale.
Anche i motori di ricerca esterni, come Google, possono indicizzare il tuo portale. Il portale per gli sviluppatori ti consente di decidere se i motori di ricerca esterni possono indicizzare o meno il tuo portale.
Configurazione di Apache Solr
Puoi configurare Apache Solr per controllare i tipi di contenuti da indicizzare, forzare un indice ed eseguire attività di configurazione aggiuntive.
Per configurare Apache Solr:
- Accedi al portale come utente con privilegi di amministratore o per la creazione di contenuti.
- Nel menu di amministrazione di Drupal, seleziona Configurazione > Ricerca e metadati > Ricerca Apache Solr.
- Utilizza questa pagina per configurare Apache Solr.
Disattivare l'indicizzazione di Google
È buona norma anche indicizzare i contenuti e renderli disponibili ai motori di ricerca. Per impostazione predefinita, i tuoi contenuti vengono indicizzati dall'indicizzatore Google. Tuttavia, puoi disattivare l'indicizzazione di Google. Ti consigliamo di eseguire questa operazione se il tuo portale per sviluppatori non è pronto per l'uso pubblico e quindi non vuoi che i tuoi contenuti siano disponibili pubblicamente per la ricerca.
Per disattivare l'indicizzazione di Google:
- Accedi al portale come utente con privilegi di amministratore o per la creazione di contenuti.
- Seleziona Modules (Moduli) nel menu di amministrazione di Drupal.
- Attiva il modulo Metatag.
- Fai clic su Save configuration (Salva configurazione).
- Nel menu di amministrazione di Drupal, seleziona Configuration > Search and metadata > Metatag (Configurazione > Ricerca e metadati).
- Seleziona l'operazione Sostituisci per il Tipo globale.
- Fai clic sulla sezione Avanzate per aprirla.
- Seleziona la casella di controllo Impedisci ai motori di ricerca di indicizzare questa pagina.
- Fai clic su Salva.
Tieni presente che nella sezione Avanzate della pagina globale sono presenti altre opzioni correlate al motore di ricerca. Ad esempio, puoi selezionare una casella di controllo per impedire ai motori di ricerca di seguire i link in una pagina. Seleziona una o più caselle di controllo in base alle esigenze.
Documentare la procedura di registrazione delle app
È importante che la documentazione includa istruzioni su come gli sviluppatori possono registrare le loro app tramite il portale per sviluppatori. Puoi utilizzare le seguenti istruzioni come punto di partenza. Queste istruzioni illustrano come registrare le app tramite il portale per sviluppatori predefinito.
Per configurare la modalità di registrazione delle app da parte degli sviluppatori sul tuo portale, consulta Configurazione della registrazione delle app per ulteriori informazioni. Se modifichi il processo di registrazione dell'app, modifica di conseguenza le istruzioni di esempio riportate di seguito.
Per registrare un'app tramite il portale per gli sviluppatori predefinito:
- Seleziona Le mie app sotto il tuo nome utente nel menu di accesso.
- Fai clic sull'icona Aggiungi (+) per nuova app.
- Inserisci i valori appropriati nella pagina Aggiungi app:
Nome app Assegna un nome univoco alla tua app. URL di callback Se necessario, fornisci l'URL di callback a cui deve essere restituita la chiamata OAuth.
Per impostazione predefinita, questo valore è obbligatorio anche se le API non utilizzano OAuth. Se le tue API non utilizzano OAuth, inserisci un valore fittizio come my.site.com.
Prodotto Seleziona uno o più prodotti basati su API. - Fai clic su Crea app per registrare l'app e generare la chiave API per l'app.