Best practice per la creazione del portale

Questa pagina si applica ad Apigee e Apigee hybrid.

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 saperne di più. Consenti ai consumer di API di esplorare una parte del tuo portale senza effettuare l'accesso. Fornisci la registrazione self-service in modo che possano iniziare rapidamente a creare app utilizzando le tue API.

Consenti agli utenti di provare le tue API

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

  • Scopri di più sull'API
  • Inviare una richiesta live all'API
  • Visualizzare una risposta in tempo reale restituita dall'API

    Per ulteriori informazioni, vedi Pubblicare le API.

Indirizzare i percorsi di apprendimento principali

Fornisci esempi di casi d'uso e tutorial pertinenti per il tuo pubblico e basati sul suo livello di esperienza. Fornisci un esempio, ad esempio una semplice sequenza di comandi curl, o illustra una procedura più elaborata.

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

Assicurati che i tuoi contenuti siano ricercabili. Investi nella SEO per migliorare il ranking nei risultati di ricerca e consentire 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 i motori di ricerca (SEO) di Google.

Best practice Descrizione Vantaggi
Creare URL user-friendly Crea URL facili da comprendere e leggibili. Definisci un URL di pagina intuitivo quando aggiungi pagine al portale, come descritto in Creare una pagina.
  • Comunica lo scopo della pagina in un formato leggibile.
  • La corrispondenza completa o parziale delle parole chiave nell'URL della pagina migliora il ranking di ricerca.
  • In genere, gli URL vengono visualizzati nei risultati di ricerca.
Fornisci un nome descrittivo del portale Definisci un nome univoco e descrittivo per il portale, come descritto in Gestire i portali. Questi contenuti vengono utilizzati per compilare il tag <title> per la home page (index) del tuo portale.
  • La corrispondenza completa o parziale delle parole chiave nel titolo migliora il ranking di ricerca.
  • In genere, i contenuti dei titoli delle pagine vengono visualizzati come prima riga dei risultati di ricerca.
Rendere il sito facile da navigare Definisci una struttura di navigazione logica, come descritto in Configurazione della navigazione.
  • Aiuta gli utenti a orientarsi.
  • Aiuta gli utenti a trovare i contenuti che desiderano in modo rapido e semplice.
Utilizzare un buon mix di frasi chiave nei contenuti Includi le 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. Cerca di prevedere le stringhe di parole chiave che gli utenti potrebbero utilizzare quando cercano i tuoi contenuti. Fai attenzione a non inserire troppe parole chiave, ovvero a non utilizzare eccessivamente le parole chiave al solo scopo di migliorare il ranking di ricerca. Ciò potrebbe comportare una penalizzazione del tuo sito da parte dei motori di ricerca. Gli utenti che cercano contenuti avranno maggiori probabilità di ottenere risultati pertinenti.

Creare una community di sviluppatori

Utilizza i social media per promuovere la tua community di API tramite i 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 di API.