Práticas recomendadas para criar seu portal

Você está vendo a documentação do Apigee Edge.
Acesse a documentação da Apigee X. informações

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:

• Saiba mais sobre a API
• Envie uma solicitação em tempo real à API

• Veja uma resposta em tempo real retornada da API

  Para mais informações, consulte Publicar APIs.

Lidar com os programas de aprendizado principais

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.

Use as seguintes práticas recomendadas ao estruturar o conteúdo. Para mais informações e diretrizes adicionais do Google, consulte o Guia para iniciantes em otimização de mecanismos de pesquisa do Google.

Prática recomendada	Descrição	Vantagens
Criar URLs fáceis de usar	Crie URLs fáceis de entender e legíveis. Defina um URL de página acessível ao adicionar páginas ao seu portal, conforme descrito em 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 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, conforme descrito em 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.