Visão geral do portal do Cloud Endpoints

É possível usar o Portal do Cloud Endpoints para criar um portal do desenvolvedor, um site que os usuários da API Cloud Endpoints podem acessar para explorar e testar a API. No portal, os desenvolvedores que usam a API com um código próprio podem encontrar a documentação de referência da API SmartDocs. O SmartDocs usa o documento OpenAPI para gerar a documentação de referência da API. O SmartDocs contém um painel Teste esta API para que os desenvolvedores consigam interagir com a API sem sair da documentação.

portal

Também é possível oferecer uma documentação personalizada para que os usuários tenham êxito no uso da API.

Visite a demonstração do portal do Endpoints para explorar o portal que foi criado a partir de várias amostras diferentes do Endpoints.

Limitações

  1. Os usuários precisam se autenticar com um projeto do GCP para acessar o portal do desenvolvedor. Usuários não autenticados não podem visualizar o portal do desenvolvedor.
  2. O serviço do Endpoints precisa ser de acesso público para usar o painel Testar esta API. As solicitações falharão se outra autenticação (como o IAP) estiver configurada no serviço do Endpoints.
  3. O Portal do Endpoints não é compatível com mensagens ou serviços com nomes idênticos declarados em namespaces separados de uma única implantação do Endpoints. Isso pode afetar os usuários que tentam seguir as práticas recomendadas para controle de versões da API com o Cloud Endpoints. Para evitar o controle de versão incorreto de mensagens ou serviços, use uma das seguintes abordagens:
    • Dê nomes exclusivos a mensagens e serviços em todos os arquivos .proto. Por exemplo, nomeie a mensagem data como data1 na versão 1, data2 na versão 2 etc.
    • Separe as versões da API em diferentes implantações do Endpoints.

A seguir