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
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.
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.
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.
[[["Facile da capire","easyToUnderstand","thumb-up"],["Il problema è stato risolto","solvedMyProblem","thumb-up"],["Altra","otherUp","thumb-up"]],[["Difficile da capire","hardToUnderstand","thumb-down"],["Informazioni o codice di esempio errati","incorrectInformationOrSampleCode","thumb-down"],["Mancano le informazioni o gli esempi di cui ho bisogno","missingTheInformationSamplesINeed","thumb-down"],["Problema di traduzione","translationIssue","thumb-down"],["Altra","otherDown","thumb-down"]],["Ultimo aggiornamento 2025-09-10 UTC."],[[["\u003cp\u003eThis page outlines best practices for building an engaging and effective developer portal using Apigee and Apigee hybrid.\u003c/p\u003e\n"],["\u003cp\u003eCreating user-friendly URLs, descriptive portal names, and intuitive navigation are crucial for enhancing searchability and user experience.\u003c/p\u003e\n"],["\u003cp\u003eEnabling interactive API documentation with live request and response capabilities allows users to quickly understand and test your APIs.\u003c/p\u003e\n"],["\u003cp\u003eIncorporating relevant content like tutorials and use case examples, that are based on various audience levels will improve the user experience.\u003c/p\u003e\n"],["\u003cp\u003eUtilizing social media and community features such as forums and blogs will help to build a stronger developer community.\u003c/p\u003e\n"]]],[],null,["# Best practices for building your portal\n\n*This page\napplies to **Apigee** and **Apigee hybrid**.*\n\n\n*View [Apigee Edge](https://docs.apigee.com/api-platform/get-started/what-apigee-edge) documentation.*\n\n\u003cbr /\u003e\n\nApigee recommends that you apply the best practices described in the following sections when building your portal.\n\nEngage your audience\n--------------------\n\nAdd content that engages your audience visually and compels them to want to learn more. Enable API consumers to explore a portion of your portal without logging in. Provide self-service registration so they can get up and running quickly to build apps using your APIs.\n\nLet users try your APIs\n-----------------------\n\nAuto-generate interactive API documentation from your OpenAPI Specifications to enable users to:\n\n- Learn about the API\n- Send a live request to the API\n- View a live response returned from the API\n\n For more information, see [Publishing your APIs](/apigee/docs/api-platform/publish/portal/publish-apis).\n\nAddress primary learning paths\n------------------------------\n\nProvide use case examples and tutorials that are relevant to your audience and based on their level of experience. Demonstrate by example, such as a simple curl command sequence, or step through a more elaborate procedure.\n| You can learn from your internal consumers. Perform usability tests with internal consumers and revise content based on their feedback.\n\nImplement search engine optimization (SEO)\n------------------------------------------\n\nEnsure your content is searchable. Invest in SEO that improves your ranking in search results and enable users to find your content.\n\nUse the following best practices when structuring your content. For more information and additional guidelines from Google, see the [Google Search Engine Optimization Starter Guide](http://static.googleusercontent.com/media/www.google.com/en//webmasters/docs/search-engine-optimization-starter-guide.pdf).\n\nBuild a developer community\n---------------------------\n\nEmploy social media to promote your API community through standard social channels, such as Facebook, Twitter, and so on. Publish blogs and forums that foster communication and interaction among the developers in your API community."]]
