Stai visualizzando la documentazione di Apigee Edge.
Vai alla documentazione di Apigee X. info
Utilizza il tipo di contenuto "Pagina di base " di Drupal per aggiungere al tuo portale per i servizi per gli sviluppatori la documentazione relativa alla tua API, ad esempio guide di istruzioni e documenti di riferimento dell'API, nonché contenuti come video, screencast o download di codice.
La pagina Documentazione è configurata con alcune voci iniziali organizzate in varie categorie, come "Introduzione" e "Tutorial". La pagina è un punto di partenza per le modifiche. In questo modo, puoi aggiungere le tue voci di contenuti e organizzarle come preferisci.
Aggiunta della home page della documentazione
Per impostazione predefinita, la home page della documentazione si trova all'indirizzo <siteURL>/documentation nel tuo portale per sviluppatori. La home page predefinita del portale per sviluppatori contiene un link a questa pagina nella casella nella parte superiore della home page:
Puoi anche aggiungere un link alla documentazione a questa pagina nel menu principale del menu del portale per sviluppatori.
Tuttavia, la home page della documentazione non esiste per impostazione predefinita, quindi devi creare una nuova pagina nel portale per sviluppatori all'URL corretto.
Per aggiungere la home page della documentazione al tuo portale per gli sviluppatori:
- Accedi al tuo portale come utente con privilegi amministrativi o di creazione di contenuti.
- Seleziona Contenuti > Aggiungi contenuti > Pagina di base nel menu di amministrazione di Drupal.
- Inserisci il titolo del documento, ad esempio Home page della documentazione, e i contenuti della prima pagina.
- Fai clic su Modifica riepilogo per aggiungere un riepilogo.
- Fai clic sull'elemento Impostazioni del menu sotto la sezione Testo.
- Seleziona Fornisci un link al menu, aggiungi il titolo del link e seleziona
<Menu principale> nell'elemento principale.
Viene aggiunto un link al menu principale della home page della documentazione. - Fai clic sull'elemento Impostazioni percorso URL sotto la sezione Testo.
- Deseleziona Genera alias URL automatico e imposta l'alias URL su
documentazione.
L'URL di una pagina è <siteURL>/content/pageName per impostazione predefinita. Impostando l'alias URL, imposti un URL esplicito della pagina, in questo caso <siteURL>/documentation. - Salva la pagina.
Ora dovresti vedere un link alla pagina nella barra dei menu e il link nella casella della home page dovrebbe funzionare.
Come amministratore, vedrai anche i pulsanti di amministrazione dei contenuti, come Visualizza e Modifica. Gli utenti non amministratori non le vedranno.
Aggiunta di una pagina secondaria alla documentazione
Quando aggiungi pagine secondarie alla documentazione:
- Accedi al tuo portale come utente con privilegi amministrativi o di 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 sull'elemento Impostazioni del menu sotto la sezione Testo.
- Seleziona Fornisci un link al menu, poi seleziona la voce del menu della home page della documentazione.
In questo modo, la pagina corrente viene aggiunta come elemento secondario del menu principale della home page della documentazione. - Ora dovresti vedere un link alla pagina nel menu della home page della documentazione.
Modificare una pagina della documentazione
Per modificare una pagina:
- Accedi al tuo portale come utente con privilegi amministrativi o di creazione di contenuti.
- Vai alla pagina nel portale per sviluppatori.
Puoi anche fare clic su Contenuti nel menu di amministrazione di Drupal per elencare tutte le tue 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 Testo.
Dovresti vedere i contenuti della pagina visualizzati nell'editor. - Modifica la pagina in base alle necessità.
- Fai clic su Salva.
Visualizzazione di qualsiasi pagina della documentazione
Per visualizzare i contenuti di un documento:
- Accedi al tuo portale come utente con privilegi amministrativi o di creazione di contenuti.
- Seleziona Contenuti nel menu di amministrazione di Drupal.
- Seleziona il documento che vuoi visualizzare.
Riordinare l'ordine delle pagine
Puoi modificare la sequenza e il livello di nidificazione delle pagine nel menu Home della documentazione.
Per riorganizzare le pagine nel menu Home della documentazione:
- Accedi al tuo portale come utente con privilegi amministrativi o di creazione di contenuti.
- Nel menu di amministrazione di Drupal, seleziona Struttura > Menu > Menu principale.
- Ogni elemento del menu ha un'icona a sinistra del nome. Se non vedi le icone, fai clic su Nascondi pesi riga.
- Per spostare un elemento, fai clic e trascina l'icona in una nuova posizione.
Se trascini un elemento con elementi secondari, vengono spostati anche questi ultimi.
- Fai clic su Salva configurazione.
Modificare le pagine del 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 condizioni all'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 tuo portale come utente con privilegi amministrativi o di creazione di contenuti.
- Seleziona Contenuti > Aggiungi contenuti > Pagina di base nel menu di amministrazione di Drupal.
- Inserisci il titolo del documento, ad esempio 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 Testo.
- Seleziona Genera alias URL automatico e imposta l'alias URL su
privacy-policy.
L'URL di una pagina è <siteURL>/content/pageName per impostazione predefinita. Se imposti 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 condizioni d'uso e Contatti.
Per modificare i contenuti di una pagina del piè di pagina, ad esempio le Norme sulla privacy, i Termini e condizioni d'uso o la pagina Contattaci, nel tuo Developer Portal:
- Accedi al tuo portale come utente con privilegi amministrativi o di 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 delle Norme sulla privacy, se necessario.
- Fai clic su Salva.
- Ripeti questa procedura per le pagine Termini e condizioni d'uso e Contatti.
Per modificare le icone dei social, ad esempio quelle di Twitter, Facebook e LinkedIn, nel portale per gli sviluppatori:
- Accedi al tuo portale come utente con privilegi amministrativi o di 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 per l'intero sito.
- Seleziona il link Configura corrispondente al blocco Piè di pagina predefinito per l'intero sito.
- Nell'area Contenuti personalizzati, fai clic con il tasto destro del mouse su un'icona di social 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 a una pagina del portale
Puoi aggiungere JavaScript a qualsiasi pagina del portale. Il modo più semplice per aggiungere JavaScript è modificare la pagina, quindi:
- Seleziona HTML completo come Formato testo.
- Seleziona il pulsante Origine per modificare il codice sorgente HTML della pagina.
- Aggiungi il codice JavaScript alla pagina. Ad esempio, per visualizzare una finestra di avviso al caricamento della pagina,
aggiungere il seguente codice:
<script language="JavaScript">
alert('Welcome to my page!');
</script>
Alcune considerazioni sull'utilizzo di JavaScript:
- Se vuoi fare riferimento a un file JavaScript, non farlo nel codice sorgente di un nodo perché viene creato un link statico. Utilizza invece il codice PHP per creare un link dinamico. In questo modo, se la posizione del file JavaScript cambia, non devi aggiornare tutte le pagine del portale che fanno riferimento al file.
- Se vuoi includere un file JavaScript, aggiungilo al tema del portale. In alternativa, se fa parte di un modulo Drupal, aggiungilo al modulo.
- Puoi anche utilizzare la funzione Drupal drupal_add_js per aggiungere JavaScript in Drupal. Per ulteriori informazioni, vedi https://api.drupal.org/api/drupal/includes!common.inc/function/drupal_add_js/7.
Controllo della presenza di link inaccessibili
È buona norma controllare che nei contenuti non siano presenti link inaccessibili. Per impostazione predefinita, il portale per gli sviluppatori è configurato per verificare la presenza di link inaccessibili in vari tipi di pagine. Ad esempio, i link vengono controllati nelle pagine di base, negli articoli, nei post del blog e negli argomenti dei forum.
Per aggiungere o rimuovere tipi di pagine dal controllo dei link:
- Nel menu di amministrazione di Drupal, seleziona Moduli e assicurati che il modulo Link Checker sia abilitato.
- Nel menu di amministrazione di Drupal, seleziona Configurazione > Creazione di contenuti > Controllo link.
- Configura i tipi di contenuti di cui vuoi eseguire la ricerca di link interrotti.
Configurazione della ricerca
Il portale per 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 controllare se i motori di ricerca esterni possono indicizzare il tuo portale.
Configurazione di Apache Solr
Puoi configurare Apache Solr per controllare i tipi di contenuti da indicizzare, per forzare un indice e per eseguire attività di configurazione aggiuntive.
Per configurare Apache Solr:
- Accedi al tuo portale come utente con privilegi amministrativi o di 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 prassi anche indicizzare i contenuti e renderli disponibili ai motori di ricerca. Per impostazione predefinita, i tuoi contenuti vengono indicizzati dall'indicizzatore di Google. Tuttavia, hai la possibilità di disattivare l'indicizzazione di Google. Ti consigliamo di farlo se il tuo Developer Portal non è pronto per l'uso pubblico e non vuoi che i tuoi contenuti siano disponibili pubblicamente per la ricerca.
Per disattivare l'indicizzazione di Google:
- Accedi al tuo portale come utente con privilegi amministrativi o di creazione di contenuti.
- Seleziona Moduli nel menu di amministrazione di Drupal.
- Attiva il modulo Metatag.
- Fai clic su Salva configurazione.
- Nel menu di amministrazione di Drupal, seleziona Configurazione > Ricerca e metadati > Metatag.
- 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 disponibili altre opzioni relative ai motori di ricerca. Ad esempio, puoi selezionare una casella di controllo per impedire ai motori di ricerca di seguire i link su una pagina. Seleziona una o più di queste caselle di controllo, a seconda dei casi.
Documenta come registrare le app
È importante che la documentazione includa istruzioni su come gli sviluppatori possono registrare le proprie app tramite il tuo portale per sviluppatori. Puoi utilizzare le seguenti istruzioni come punto di partenza: queste istruzioni spiegano 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 Configurare la registrazione delle app per saperne di più. Se modifichi la procedura di registrazione dell'app, modifica di conseguenza le istruzioni di esempio riportate di seguito.
Per registrare un'app tramite il portale per sviluppatori predefinito:
- Seleziona Le mie app sotto il tuo nome utente nel menu di accesso.
- Fai clic sull'icona Aggiungi (+) nuova app.
- Inserisci i valori appropriati nella pagina Aggiungi app:
Nome app Fornisci un nome univoco per l'app. URL di chiamata Se necessario, fornisci l'URL di callback a cui deve tornare la chiamata OAuth.
Per impostazione predefinita, questo valore è obbligatorio anche se le tue 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 API. - Fai clic su Crea app per registrare l'app e generare la chiave API per l'app.