Best practice per la creazione del portale

Questa pagina si applica a Apigee e Apigee ibrido.

Visualizza la documentazione di Apigee Edge.

Apigee consiglia di applicare le best practice descritte nelle sezioni seguenti durante la creazione del portale.

Coinvolgi il tuo pubblico

Aggiungi contenuti che coinvolgano visivamente il tuo pubblico e lo invoglino a voler saperne di più. Consenti ai consumer delle API di esplorare una parte del tuo portale senza effettuare l'accesso. Fornisci la registrazione self-service in modo che possano essere operativi in poco tempo per creare app utilizzando le tue API.

Consenti agli utenti di provare le tue API

Genera automaticamente documentazione API interattiva dalle tue specifiche OpenAPI per consentire agli utenti di:

  • Scopri di più sull'API
  • Invia una richiesta in tempo reale all'API

  • Visualizzare una risposta in tempo reale restituita dall'API

    Per ulteriori informazioni, consulta la sezione Pubblicazione delle API.

Gestire i principali percorsi di apprendimento

Fornisci esempi e tutorial di casi d'uso che siano pertinenti per il tuo pubblico e in base al suo livello di esperienza. Puoi dimostrare con un esempio, ad esempio una semplice sequenza di comandi curl, o seguire una procedura più elaborata.

Implementare l'ottimizzazione per i motori di ricerca (SEO)

Assicurati che i tuoi contenuti siano disponibili per la ricerca. Investi nella SEO che migliora il tuo ranking nei risultati di ricerca e permetta agli utenti di trovare i tuoi contenuti.

Ottimizzazione per i motori di ricerca

Utilizza le seguenti best practice per strutturare i tuoi contenuti. Per ulteriori informazioni e linee guida aggiuntive di Google, consulta la Guida introduttiva all'ottimizzazione per motori di ricerca di Google.

Best practice Descrizione Vantaggi
Crea URL facili da usare Crea URL facilmente comprensibili e leggibili da una persona. Definisci un URL di pagina facile da usare quando aggiungi pagine al portale, come descritto nella sezione Creazione di una pagina.
  • Trasmettano lo scopo della pagina in un formato leggibile.
  • La corrispondenza completa o parziale delle parole chiave nell'URL della pagina migliora il ranking nei risultati di ricerca.
  • In genere, gli URL vengono visualizzati nei risultati di ricerca.
Fornisci un nome descrittivo per il portale Definisci un nome univoco e descrittivo per il portale, come descritto in Gestione dei portali. Questi contenuti vengono utilizzati per completare il tag <title> per la home page (index) del tuo portale.
  • La corrispondenza completa o parziale delle parole chiave nel titolo migliora il ranking nei risultati di ricerca.
  • In genere, i contenuti dei titoli delle pagine vengono visualizzati nella prima riga dei risultati di ricerca.
Rendi il tuo sito facile da navigare Definisci una struttura di navigazione logica, come descritto in Configurare la navigazione.
  • Mantiene orientati gli utenti.
  • Aiuta gli utenti a trovare i contenuti che cercano in modo facile e veloce.
Utilizza una buona combinazione di frasi chiave in tutti i contenuti Includi parole chiave nei tuoi contenuti quando sono pertinenti e ha senso farlo. L'evidenza di una stringa di parole chiave nella pagina può migliorare il ranking della pagina nei risultati di ricerca. Prova a prevedere le stringhe di parole chiave che gli utenti potrebbero utilizzare per cercare i tuoi contenuti. Fai attenzione a non utilizzare numerose parole chiave, ovvero fare un uso eccessivo di parole chiave al solo scopo di migliorare il ranking nei risultati di ricerca. Questo può comportare una penalizzazione del tuo sito da parte dei motori di ricerca. Gli utenti che cercano contenuti avranno maggiori probabilità di ricevere hit pertinenti.

Crea una community di sviluppatori

Utilizza i social media per promuovere la community dell'API tramite canali social standard, come Facebook, Twitter e così via. Pubblica blog e forum che favoriscono la comunicazione e l'interazione tra gli sviluppatori della tua community API.