Você está visualizando a documentação do Apigee Edge.
Acesse a
documentação da
Apigee X. info
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 suas 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 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 Criar uma página. |
|
| Fornecer um nome de portal descritivo | Defina um nome de portal exclusivo e descritivo, conforme descrito em Gerenciar seus portais. Esse conteúdo é usado para preencher a tag <title> da página inicial (index) do seu portal. |
|
| Facilitar a navegação no site | Defina uma estrutura de navegação que faça sentido lógico, conforme descrito em Configurar a navegação. |
|
| 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.