Best practice per la creazione del portale

Stai visualizzando la documentazione di Apigee Edge.
Consulta la documentazione di Apigee X. info

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 spingano a saperne di più. Consenti ai consumatori di API di esplorare una parte del portale senza dover eseguire l'accesso. Fornisci una 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 la documentazione dell'API interattiva dalle specifiche OpenAPI per consentire agli utenti di:

• Scoprire l'API
• Inviare una richiesta live all'API

• Visualizzare una risposta live restituita dall'API

  Per ulteriori informazioni, vedi Pubblicare le API.

Affronta 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. Mostra un esempio, ad esempio una semplice sequenza di comandi curl, oppure segui una procedura più elaborata.

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

Assicurati che i contenuti siano ricercabili. Investi nella SEO per migliorare il ranking nei risultati di ricerca e consentire agli utenti di trovare i tuoi contenuti.

Utilizza le seguenti best practice per strutturare i 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
Crea URL di facile utilizzo	Crea URL di facile comprensione e leggibili. Definisci un URL di pagina di facile utilizzo quando aggiungi pagine al portale, come descritto in Creare una pagina.	Indica 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 del portale univoco e descrittivo per il tuo portale, come descritto in Gestire i portali. Questi contenuti vengono utilizzati per popolare il <title> tag della home page (index) del 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.
Rendi il tuo sito di facile navigazione	Definisci una struttura di navigazione logica, come descritto in Configurare la navigazione.	Mantiene gli utenti orientati. Aiuta gli utenti a trovare i contenuti che vogliono in modo rapido e semplice.
Utilizza un buon mix di frasi con parole chiave nei contenuti	Includi le parole chiave nei contenuti quando sono pertinenti e hanno senso. La visibilità 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 riempire di parole chiave, ovvero a non utilizzare eccessivamente le parole chiave al solo scopo di migliorare il ranking di ricerca. In questo modo, i motori di ricerca potrebbero penalizzare il tuo sito.	Gli utenti che cercano contenuti avranno maggiori probabilità di ottenere risultati pertinenti.

Crea 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 promuovano la comunicazione e l'interazione tra gli sviluppatori della tua community di API.