Esta página aplica-se ao Apigee e ao Apigee Hybrid.
Veja a documentação do
Apigee Edge.
A Apigee recomenda que aplique as práticas recomendadas descritas nas secções seguintes ao criar o seu portal.
Interaja com o seu público
Adicione conteúdo que envolva o público visualmente e o motive a querer saber mais. Permitir que os consumidores da API explorem uma parte do seu portal sem iniciar sessão. Ofereça um registo self-service para que possam começar a criar apps rapidamente com as suas APIs.
Permita que os utilizadores experimentem as suas APIs
Gere automaticamente documentação interativa da API a partir das suas especificações da OpenAPI para permitir que os utilizadores:
- Saiba mais sobre a API
- Envie um pedido em direto para a API
Veja uma resposta em direto devolvida pela API
Para mais informações, consulte o artigo Publicar as suas APIs.
Aborde os percursos de aprendizagem principais
Forneça exemplos de casos de utilização e tutoriais relevantes para o seu público e com base no respetivo nível de experiência. Demonstre através de exemplos, como uma sequência de comandos curl simples, ou siga um procedimento mais elaborado.
Implemente a otimização do motor de pesquisa (SEO)
Certifique-se de que o seu conteúdo é pesquisável. Invista em SEO que melhore a sua classificação nos resultados da pesquisa e permita que os utilizadores encontrem o seu conteúdo.
Use as seguintes práticas recomendadas ao estruturar o seu conteúdo. Para mais informações e diretrizes adicionais da Google, consulte o Manual de Iniciação à Otimização do Motor de Pesquisa da Google.
| Prática recomendada | Descrição | Vantagens |
|---|---|---|
| Crie URLs fáceis de usar | Crie URLs fáceis de compreender e legíveis por humanos. Defina um URL da página intuitivo quando adicionar páginas ao seu portal, conforme descrito em Criar uma página. |
|
| Indique um nome descritivo para o portal | Defina um nome único e descritivo para o seu portal, conforme descrito no artigo Gerir os seus portais. Este conteúdo é usado para preencher a etiqueta <title> para a página inicial (index) do seu portal. |
|
| Facilite a navegação no seu site | Defina uma estrutura de navegação que faça sentido lógico, conforme descrito no artigo Configurar a navegação. |
|
| Use uma boa combinação de palavras-chave expressão ao longo do conteúdo | Inclua palavras-chave no seu conteúdo quando for relevante e fizer sentido fazê-lo. A proeminência de uma sequência de palavras-chave na sua página pode melhorar a classificação da página nos resultados da pesquisa. Tente prever as sequências de palavras-chave que os utilizadores podem usar quando pesquisam o seu conteúdo. Tenha cuidado para não encher o texto com palavras-chave, ou seja, usar palavras-chave em excesso com o único objetivo de melhorar a classificação na pesquisa. Isto pode resultar na aplicação de penalizações ao seu site por parte dos motores de pesquisa. | Os utilizadores que pesquisam conteúdo têm maior probabilidade de receber resultados relevantes. |
Crie uma comunidade de programadores
Use as redes sociais para promover a sua comunidade de APIs através de canais sociais padrão, como o Facebook, o Twitter, etc. Publicar blogues e fóruns que fomentem a comunicação e a interação entre os programadores na sua comunidade de APIs.