Best practice per la creazione del portale

Stai visualizzando la documentazione di Apigee Edge.
Vai alla 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 coinvolgono il pubblico visivamente e lo spingono a voler saperne di più. Consenti ai consumer delle API di esplorare una parte del tuo portale senza accedere. Offri la registrazione self-service in modo che possano iniziare a utilizzare rapidamente le tue API per creare app.

Consentire agli utenti di provare le tue API

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

• Informazioni sull'API
• Invia una richiesta in tempo reale all'API

• Visualizzare una risposta in tempo reale restituita dall'API

  Per ulteriori informazioni, vedi Pubblicare le API.

Rispondere ai percorsi di apprendimento principali

Fornisci tutorial ed esempi di casi d'uso pertinenti al tuo pubblico e in base al suo livello di esperienza. Dimostra con un esempio, ad esempio una semplice sequenza di comandi curl, o segui una procedura più elaborata.

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

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

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

Best practice	Descrizione	Vantaggi
Creare URL facili da usare	Crea URL semplici e leggibili. Definisci un URL pagina facile da usare quando aggiungi pagine al tuo 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 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 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 nei risultati di ricerca. In genere, i contenuti dei titoli delle pagine vengono visualizzati come 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 gli utenti orientati. Aiutano gli utenti a trovare i contenuti che vogliono in modo rapido e semplice.
Utilizza una buona combinazione 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. Prova a prevedere le stringhe di parole chiave che gli utenti potrebbero utilizzare per cercare i tuoi contenuti. Fai attenzione a non inserire troppe parole chiave, ovvero a non abusare delle parole chiave al solo scopo di migliorare il ranking nei risultati di ricerca. Ciò potrebbe comportare la 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 API tramite 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 API.