Apigee recomienda que aplique las prácticas recomendadas que se describen en las siguientes secciones al crear su portal.
Capta la atención de tu audiencia
Añade contenido que atraiga visualmente a tu audiencia y la anime a obtener más información. Permite que los consumidores de APIs exploren una parte de tu portal sin iniciar sesión. Ofrece un registro de autoservicio para que puedan empezar a crear aplicaciones con tus APIs rápidamente.
Permitir que los usuarios prueben tus APIs
Genera automáticamente documentación interactiva de las APIs a partir de tus especificaciones de OpenAPI para que los usuarios puedan hacer lo siguiente:
Información sobre la API
Enviar una solicitud activa a la API
Ver una respuesta en directo devuelta por la API
Para obtener más información, consulta el artículo Publicar APIs.
Abordar los planes de formación principales
Proporciona ejemplos de casos prácticos y tutoriales que sean relevantes para tu audiencia y que se adapten a su nivel de experiencia. Demuestra con un ejemplo, como una secuencia de comandos curl sencilla, o sigue un procedimiento más elaborado.
Implementar la optimización en buscadores (SEO)
Asegúrate de que tu contenido se pueda buscar. Invierte en SEO para mejorar tu posicionamiento en los resultados de búsqueda y permitir que los usuarios encuentren tu contenido.
Crea URLs fáciles de entender y descriptivas. Define una URL de página intuitiva al añadir páginas a tu portal, tal como se describe en el artículo Crear una página.
Indica el propósito de la página de forma legible.
La coincidencia total o parcial de palabras clave en la URL de la página mejora la clasificación de búsqueda.
Normalmente, las URLs aparecen en los resultados de búsqueda.
Proporciona un nombre descriptivo para el portal
Define un nombre de portal único y descriptivo para tu portal, tal como se describe en el artículo Gestionar tus portales. Este contenido se usa para rellenar la etiqueta <title> de la página principal (index) de su portal.
La concordancia total o parcial de palabras clave en el título mejora la clasificación en las búsquedas.
Normalmente, el contenido de los títulos de las páginas se muestra como la primera línea de los resultados de búsqueda.
Ayuda a los usuarios a encontrar el contenido que quieren de forma rápida y sencilla.
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 prominencia de una cadena de palabras clave en tu página puede mejorar el posicionamiento de la página en los resultados de búsqueda. Intenta predecir las cadenas de palabras clave que los usuarios podrían usar al buscar tu contenido. No incluyas palabras clave en exceso, es decir, no uses palabras clave de forma excesiva con el único propósito de mejorar la clasificación en las búsquedas. Esto puede provocar que los buscadores penalicen su sitio.
Los usuarios que busquen contenido tendrán más probabilidades de obtener resultados relevantes.
Crea una comunidad de desarrolladores
Usa las redes sociales para promocionar tu comunidad de APIs a través de canales sociales estándar, como Facebook, Twitter, etc. Publica blogs y foros que fomenten la comunicación y la interacción entre los desarrolladores de tu comunidad de APIs.
[[["Es fácil de entender","easyToUnderstand","thumb-up"],["Me ofreció una solución al problema","solvedMyProblem","thumb-up"],["Otro","otherUp","thumb-up"]],[["Es difícil de entender","hardToUnderstand","thumb-down"],["La información o el código de muestra no son correctos","incorrectInformationOrSampleCode","thumb-down"],["Me faltan las muestras o la información que necesito","missingTheInformationSamplesINeed","thumb-down"],["Problema de traducción","translationIssue","thumb-down"],["Otro","otherDown","thumb-down"]],["Última actualización: 2025-09-11 (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."]]
