Best practice per la creazione del portale

Stai visualizzando la documentazione di Apigee Edge.
Vai alla documentazione di Apigee X. informazioni

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

Coinvolgi il pubblico

Aggiungi contenuti che coinvolgano visivamente il pubblico e lo invoglino a volerne sapere di più. Consenti ai consumer delle API di esplorare una parte del tuo portale senza eseguire l'accesso. Fornisci la registrazione self-service in modo che i tuoi clienti possano iniziare a creare rapidamente app utilizzando le tue API.

Consenti agli utenti di provare le tue API

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

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

• Visualizza una risposta in tempo reale restituita dall'API

  Per saperne di più, consulta la sezione Pubblicare le API.

Indirizzare i percorsi di apprendimento principali

Fornisci esempi di casi d'uso ed tutorial pertinenti per il tuo pubblico e in base al suo livello di esperienza. Fai un esempio, come una semplice sequenza di comando curl, o procedi con una procedura più elaborata.

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

Assicurati che i tuoi contenuti siano disponibili per la ricerca. Investi in SEO che migliorino il ranking nei risultati di ricerca e consentano agli utenti di trovare i tuoi contenuti.

Segui queste 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. Definisci un URL di pagina facile da capire quando aggiungi pagine al tuo portale, come descritto nella sezione Creare una pagina.	Mostra lo scopo della pagina in un formato leggibile. La corrispondenza totale 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 tuo portale, come descritto nella sezione Gestire i portali. Questi contenuti vengono utilizzati per compilare il tag <title> per la home page (index) del portale.	La corrispondenza totale 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.
Rendere il sito di facile navigazione	Definisci una struttura di navigazione che abbia senso, 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 quando cercano i tuoi contenuti. Fai attenzione a non utilizzare parole chiave, ovvero un uso eccessivo di parole chiave al solo scopo di migliorare il ranking nei risultati di ricerca. Di conseguenza, il tuo sito potrebbe essere penalizzato dai motori di ricerca.	Gli utenti che cercano contenuti avranno maggiori probabilità di ottenere hit pertinenti.

Crea una community di sviluppatori

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