A Apigee recomenda que você aplique as práticas recomendadas descritas nas seções a seguir ao criar seu portal.
Envolver seu público-alvo
Adicione conteúdo que envolva o público visualmente e faça com que eles queiram saber mais. Permita que os consumidores da API explorem uma parte do portal sem fazer login. Forneça registro de autoatendimento para que eles possam começar a criar apps usando suas APIs rapidamente.
Permitir que usuários testem suas APIs
Gere documentação de API interativa automaticamente a partir das especificações da OpenAPI para permitir que os usuários:
Forneça exemplos de casos de uso e tutoriais relevantes para seu público-alvo e com base no nível de experiência dele. Demonstre, por exemplo, como procede uma sequência de comando curl simples ou um procedimento mais elaborado.
Implementar a otimização de mecanismos de pesquisa (SEO)
Garanta que seu conteúdo seja pesquisável. Invista em SEO que melhore sua classificação nos resultados de pesquisa e permita que os usuários encontrem seu conteúdo.
Crie URLs legíveis e fáceis de entender. Defina um URL de página fácil de usar ao adicionar páginas ao seu portal, conforme descrito em Como criar uma página.
Transmita a finalidade da página de maneira legível.
A correspondência total ou parcial de palavras-chave no URL da página melhora a classificação da pesquisa.
Normalmente, os URLs aparecem nos resultados da pesquisa.
Fornecer um nome de portal descritivo
Defina um nome de portal exclusivo e descritivo para seu portal, conforme descrito em Como gerenciar seus portais. Esse conteúdo é usado para preencher a tag <title> da página inicial (index) do seu portal.
A correspondência completa ou parcial de palavras-chave no título melhora a classificação da pesquisa.
Normalmente, o conteúdo dos títulos das páginas é exibido como a primeira linha dos resultados da pesquisa.
Facilitar a navegação no site
Defina uma estrutura de navegação que faça sentido lógico, conforme descrito em Como configurar a navegação.
Mantenha os usuários orientados.
Ajude os usuários a localizar o conteúdo que pretendido com rapidez e facilidade.
Usar uma boa combinação de frases de palavras-chave em todo o conteúdo
Inclua palavras-chave em seu conteúdo quando for relevante e faça sentido. O destaque de uma string de palavra-chave na sua página pode melhorar a classificação das páginas nos resultados da pesquisa. Tente prever as strings de palavras-chave que os usuários podem usar ao pesquisar seu conteúdo. Tenha cuidado para não usar palavras-chave, ou seja, usar palavras-chave em excesso para melhorar a classificação das pesquisas. Isso pode fazer com que o site seja penalizado pelos mecanismos de pesquisa.
Os usuários que pesquisarem conteúdo terão mais chances de receber hits relevantes.
Criar uma comunidade de desenvolvedores
Use mídias sociais para promover sua comunidade de API por meio de canais sociais padrão, como Facebook, Twitter e assim por diante. Publique blogs e fóruns que promovem a comunicação e a interação entre os desenvolvedores na comunidade da API.
[[["Fácil de entender","easyToUnderstand","thumb-up"],["Meu problema foi resolvido","solvedMyProblem","thumb-up"],["Outro","otherUp","thumb-up"]],[["Difícil de entender","hardToUnderstand","thumb-down"],["Informações incorretas ou exemplo de código","incorrectInformationOrSampleCode","thumb-down"],["Não contém as informações/amostras de que eu preciso","missingTheInformationSamplesINeed","thumb-down"],["Problema na tradução","translationIssue","thumb-down"],["Outro","otherDown","thumb-down"]],["Última atualização 2025-08-18 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."]]
