Apigee recomienda que apliques las prácticas recomendadas que se describen en las siguientes secciones cuando crees tu portal.
Haz participar a tu público
Agrega contenido que atraiga a tu público de manera visual y los motive a querer obtener más información. Permite que los consumidores de API exploren una parte de tu portal sin que tengan que acceder a sus cuentas. Proporciona un registro de autoservicio para que puedan comenzar a compilar rápidamente apps mediante tus API.
Deja que los usuarios prueben tus API
Genera de forma automática la documentación interactiva de la API a partir de tus especificaciones de OpenAPI para permitir a los usuarios hacer lo siguiente:
Obtener información sobre la API
Envía una solicitud a la API.
Visualiza una respuesta en vivo que muestra la API
Proporciona instructivos y ejemplos de casos de uso que sean relevantes para tu público y según su nivel de experiencia. Demuestra mediante un ejemplo, como una secuencia de comandos curl simple, o exhibe un procedimiento más detallado.
Implementa la optimización para motores de búsqueda (SEO)
Asegúrate de que tu contenido se pueda buscar. Invierte en SEO que mejore tu clasificación en los resultados de la búsqueda y permita que los usuarios encuentren tu contenido.
Crea URL legibles y fáciles de entender. Define una URL fácil de usar cuando agregues páginas a tu portal, como se describe en Crea una página.
Transmite el propósito de la página de una forma legible.
La coincidencia completa o parcial de las palabras clave en la URL de la página mejora la clasificación de búsqueda.
Por lo general, las URL aparecen en los resultados de la búsqueda.
Proporciona un nombre descriptivo del portal
Define un nombre de portal único y descriptivo para tu portal, como se describe en Administra tus portales. Este contenido se usa para propagar la etiqueta <title> de la página principal (index) de tu portal.
La coincidencia completa o parcial de las palabras clave en el título mejora la clasificación de búsqueda.
Por lo general, el contenido de los títulos de tus páginas se muestra como la primera línea de los resultados de la búsqueda.
Facilita la navegación en tu sitio
Define una estructura de navegación que tenga sentido lógico, como se describe en Configura la navegación.
Haz que los usuarios se sientan orientados.
Ayuda a los usuarios a encontrar el contenido que desean con rapidez y facilidad.
Usa una buena combinación de frases de palabras clave en todo el contenido
Incluye palabras clave en tu contenido cuando sea relevante y tenga sentido hacerlo. La importancia de una string de palabras clave en tu página puede mejorar la clasificación de la página en los resultados de la búsqueda. Intenta predecir las strings de palabras clave que los usuarios podrían usar cuando busquen tu contenido. Ten cuidado de no usar demasiadas palabras clave, es decir, usar muchas palabras clave con el único propósito de mejorar la clasificación de búsqueda. Esto podría provocar que los motores de búsqueda penalicen tu sitio.
Es más probable que los usuarios que buscan contenido obtengan resultados relevantes.
Crea una comunidad de desarrolladores
Usa las redes sociales para promocionar tu comunidad de API a través de canales sociales estándar, como Facebook, Twitter, etcétera. Publica blogs y foros que fomenten la comunicación y la interacción entre los desarrolladores de tu comunidad de API.
[[["Fácil de comprender","easyToUnderstand","thumb-up"],["Resolvió mi problema","solvedMyProblem","thumb-up"],["Otro","otherUp","thumb-up"]],[["Difícil de entender","hardToUnderstand","thumb-down"],["Información o código de muestra incorrectos","incorrectInformationOrSampleCode","thumb-down"],["Faltan la información o los ejemplos que necesito","missingTheInformationSamplesINeed","thumb-down"],["Problema de traducción","translationIssue","thumb-down"],["Otro","otherDown","thumb-down"]],["Última actualización: 2025-09-04 (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."]]
