Você está vendo a documentação do Apigee Edge.
Acesse a
documentação da Apigee X. informações
Use o tipo de conteúdo "Página básica" do Drupal para adicionar a documentação sobre sua API, como guias de instruções e documentos de referência da API, ao portal de serviços para desenvolvedores e inclua conteúdo como vídeos, screencasts ou downloads de código.
A página "Documentação" é configurada com algumas entradas iniciais organizadas em várias categorias, como "Primeiros passos" e "Tutoriais". A página é um ponto de partida para você editar. Dessa forma, você pode adicionar suas próprias entradas de conteúdo e organizá-las da maneira que quiser.
Como adicionar a página inicial da documentação
Por padrão, a página inicial da documentação fica em <siteURL>/document no portal do desenvolvedor. A página inicial padrão do portal do desenvolvedor contém um link para ela na caixa na parte superior da página inicial:
Também é possível adicionar um link de documentação a essa página no menu principal do menu do portal do desenvolvedor.
No entanto, a página inicial da documentação não existe por padrão. Por isso, é necessário criar uma nova página no portal do desenvolvedor no URL correto.
Para adicionar a página inicial da documentação ao portal do desenvolvedor:
- Faça login no portal como usuário com privilégios de administrador ou de criação de conteúdo.
- Selecione Conteúdo > Adicionar conteúdo > Página básica no menu de administração do Drupal.
- Digite o título do documento, como a página inicial da documentação, e o conteúdo da primeira página.
- Clique em Editar resumo para adicionar um resumo.
- Clique no item de configurações Menu abaixo da seção Corpo.
- Selecione Provide a menu link, adicione o título do link e selecione
<Main menu> no Parent Item.
Isso adiciona um link ao menu principal da página inicial de documentação. - Clique no item Configurações do caminho do URL abaixo da seção "Corpo".
- Desmarque Gerar alias de URL automático e defina o alias do URL como
a documentação.
Por padrão, o URL da página é <siteURL>/content/pageName. Ao configurar o alias do URL, você define um URL explícito da página, neste caso, como <siteURL>/document. - Salve a página.
Agora você verá um link para a página na barra de menus, e o link na caixa da página inicial funcionará.
Como administrador, você também verá botões de administração de conteúdo, como "Ver" e "Editar". Os usuários que não são administradores não terão acesso a essas informações.
Como adicionar uma página filha à sua documentação
Ao adicionar páginas filhas à documentação:
- Faça login no portal como usuário com privilégios de administrador ou de criação de conteúdo.
- Selecione Conteúdo > Adicionar conteúdo > Página básica no menu de administração do Drupal.
- Digite o título da página e o conteúdo.
- Clique em Editar resumo para adicionar um resumo.
- Clique no item de configurações Menu abaixo da seção Corpo.
- Selecione Fornecer um link de menu e adicione o item de menu da página inicial da documentação.
Isso adiciona uma página atual como filha do menu principal da página inicial da documentação. - Agora você verá um link para a página no menu da página inicial de documentação.
Como editar uma página de documentação
Para editar uma página:
- Faça login no portal como usuário com privilégios de administrador ou de criação de conteúdo.
- Acesse a página no portal do desenvolvedor.
Também é possível clicar em Conteúdo no menu de administração do Drupal para listar todas as páginas e selecionar uma. - Selecione a guia Editar na página.
- Abra um editor visual selecionando HTML completo ou HTML filtrado no menu suspenso “Formato de texto” abaixo da seção “Corpo”.
O conteúdo da página vai aparecer no editor. - Edite a página conforme necessário.
- Clique em "Salvar".
Exibir qualquer página de documentação
Para mostrar o conteúdo de um documento:
- Faça login no portal como usuário com privilégios de administrador ou de criação de conteúdo.
- Selecione Conteúdo no menu de administração do Drupal.
- Selecione o documento que você quer visualizar.
Como reorganizar a ordem das páginas
Você pode alterar a sequência e o nível de aninhamento das páginas no menu inicial "Documentação".
Para reorganizar páginas no menu inicial de "Documentação":
- Faça login no portal como usuário com privilégios de administrador ou de criação de conteúdo.
- No menu de administração do Drupal, selecione Structure > Menus > Menu principal.
- Cada item no menu tem um ícone à esquerda do nome. Se os ícones não aparecerem, clique em Ocultar pesos de linha.
- Para mover um item, clique e arraste o ícone para movê-lo para um novo local.
Arrastar um item com itens filhos também move os itens filhos.
- Clique em Save Configuration.
Editar páginas de rodapé
O rodapé do portal contém três ícones de redes sociais para Twitter, Facebook e LinkedIn, e links com os seguintes URLs:
- Política de Privacidade no URL <siteURL>/privacy-policy
- Termos e Uso para o URL <siteURL>/terms-use
- Páginas de contato com o URL <siteURL>/contact-us
Edite estas páginas para adicionar seu próprio conteúdo.
Crie essas páginas se elas não existirem:
- Faça login no portal como usuário com privilégios de administrador ou de criação de conteúdo.
- Selecione Conteúdo > Adicionar conteúdo > Página básica no menu de administração do Drupal.
- Digite o título do documento, como a Política de Privacidade, e o conteúdo da página.
- Clique em Editar resumo para adicionar um resumo.
- Clique no item Configurações do caminho do URL abaixo da seção "Corpo".
- Selecione Gerar alias de URL automático e defina o alias do URL como
política de privacidade.
Por padrão, o URL da página é <siteURL>/content/pageName. Ao configurar o alias do URL, você define um URL explícito da página, neste caso, como <siteURL>/privacy-policy. - Salve a página.
- Repita esse processo para as páginas "Termos e Uso" e "Contato".
Para editar o conteúdo de uma página de rodapé, como a Política de Privacidade, os Termos de Uso ou a página de contato, no seu portal do desenvolvedor:
- Faça login no portal como usuário com privilégios de administrador ou de criação de conteúdo.
- Acesse a página clicando no link no rodapé. Por exemplo, clique no link Política de Privacidade.
- Clique na guia Editar na página para abrir o editor.
- Altere o conteúdo da página da Política de Privacidade conforme apropriado.
- Clique em Salvar.
- Repita esse processo para as páginas "Termos e Uso" e "Contato".
Para editar os ícones de redes sociais, como os ícones do Twitter, Facebook e LinkedIn, no seu portal do desenvolvedor:
- Faça login no portal como usuário com privilégios de administrador ou de criação de conteúdo.
- Selecione Structure > Blocos no menu de administração do Drupal.
- Role a página "Bloqueios" para baixo até ver o bloco Rodapé padrão em todo o site.
- Selecione o link configure correspondente ao bloco de rodapé padrão em todo o site.
- Na área Conteúdo personalizado, clique com o botão direito do mouse em um ícone de rede social e selecione Editar link no menu pop-up. Ou exclua o ícone da área "Conteúdo personalizado"
para removê-lo.
- Selecione Salvar bloco para salvar as mudanças.
Como adicionar JavaScript a uma página do portal
Você pode adicionar JavaScript a qualquer página do portal. A maneira mais fácil de adicionar JavaScript é editar a página e:
- Selecione HTML completo como o Formato de texto.
- Selecione o botão Origem para editar o código-fonte HTML da página.
- Adicione seu JavaScript à página. Por exemplo, para abrir uma caixa de alerta quando a página for carregada,
adicione o seguinte código:
<script language="JavaScript">
alert('Welcome to my page!');
</script>
Algumas considerações sobre o uso do JavaScript:
- Se você for referenciar um arquivo JavaScript, não faça isso no código-fonte de um nó, porque isso cria um link estático. Em vez disso, use o código PHP para criar um link dinâmico. Dessa forma, se o local do arquivo JavaScript mudar, não vai ser necessário atualizar todas as páginas do portal que fazem referência a ele.
- Se você quiser incluir um arquivo JavaScript, adicione-o ao tema do portal. Ou, se fizer parte de um módulo Drupal, adicione-o ao módulo.
- Você também pode usar a função drupal_add_js do Drupal para adicionar JavaScript no Drupal. Para mais informações, consulte https://api.drupal.org/api/drupal/includes!common.inc/function/drupal_add_js/7.
Como verificar se há links corrompidos
É recomendável verificar se há links corrompidos no seu conteúdo. Por padrão, o portal do desenvolvedor é configurado para verificar vários tipos de páginas em busca de links corrompidos. Por exemplo, os links são verificados em páginas básicas, artigos, entradas de blog e tópicos de fóruns.
Para adicionar ou remover tipos de página usando a verificação de link:
- No menu de administração do Drupal, selecione Modules e verifique se o módulo Link Checker está ativado.
- No menu de administração do Drupal, selecione Configuração > Criação de conteúdo > Verificador de links.
- Configure os tipos de conteúdo que você quer verificar se há links corrompidos.
Como configurar a pesquisa
O portal do desenvolvedor tem um mecanismo de pesquisa integrado implementado pelo Apache Solr, que usa a biblioteca de pesquisa Apache Lucene. Esse é o mecanismo de pesquisa do próprio site, que o usuário acessa pela caixa de pesquisa no canto superior direito de todas as páginas do portal.
Mecanismos de pesquisa externos, como o Google, também podem indexar seu portal. O portal do desenvolvedor permite controlar se os mecanismos de pesquisa externos podem indexar seu portal.
Como configurar o Apache Solr
É possível configurar o Apache Solr para controlar os tipos de conteúdo a serem indexados, para forçar um índice e executar outras tarefas de configuração.
Para configurar o Apache Solr:
- Faça login no portal como usuário com privilégios de administrador ou de criação de conteúdo.
- No menu de administração do Drupal, selecione Configuração > Pesquisa e metadados > Pesquisa do Apache Solr.
- Use esta página para configurar o Apache Solr.
Desativar a indexação do Google
Também recomendamos indexar seu conteúdo e disponibilizá-lo para mecanismos de pesquisa. Por padrão, o conteúdo é indexado pelo indexador do Google. No entanto, você tem a opção de desativar a indexação do Google. Faça isso se o portal do desenvolvedor não estiver pronto para uso público e você não quiser que seu conteúdo seja publicamente pesquisável.
Para desativar a indexação do Google:
- Faça login no portal como usuário com privilégios de administrador ou de criação de conteúdo.
- Selecione Modules no menu de administração do Drupal.
- Ative o módulo Metatags.
- Clique em Salvar configuração.
- No menu de administração do Drupal, selecione Configuração > Pesquisa e metadados > Metatag.
- Selecione a operação Override para o Tipo global.
- Clique na seção Avançado para abri-la.
- Marque a caixa de seleção "Impedir que os mecanismos de pesquisa indexem essa página".
- Clique em Salvar.
Há outras opções relacionadas ao mecanismo de pesquisa na seção "Avançado" da página global. Por exemplo, você pode marcar uma caixa de seleção para impedir que mecanismos de pesquisa sigam links em uma página. Marque uma ou mais dessas caixas de seleção conforme apropriado.
Documentar como registrar apps
É importante que sua documentação inclua instruções sobre como os desenvolvedores podem registrar os apps deles no seu portal. Você pode usar as instruções a seguir como ponto de partida. Elas abrangem como registrar apps no portal do desenvolvedor padrão.
Para configurar como os desenvolvedores registram apps no seu portal, consulte Como configurar o registro de apps para mais informações. Se você modificar o processo de registro do app, modifique as instruções de exemplo abaixo de acordo.
Para registrar um app no portal padrão do desenvolvedor:
- Selecione Meus apps abaixo do seu nome de usuário no menu de login.
- Clique no ícone de novo app Add (+).
- Insira os valores adequados na página Adicionar aplicativo:
Nome do app Forneça um nome exclusivo para seu aplicativo. URL de callback Se necessário, forneça o URL de retorno de chamada do OAuth.
Por padrão, esse valor é obrigatório mesmo que suas APIs não usem o OAuth. Se suas APIs não usarem OAuth, insira um valor fictício, como my.site.com.
Produto Selecione um ou mais produtos de API. - Clique em Criar app para registrar o app e gerar a chave de API para ele.