Você está lendo a documentação do Apigee Edge.
Acesse a
documentação da Apigee X. info
Como provedor de API, você precisa de uma maneira de expor suas APIs, educar os desenvolvedores sobre elas, inscrever desenvolvedores e permitir que eles registrem apps. O Apigee Edge oferece um portal de serviços para desenvolvedores que pode ser usado para criar e lançar seu próprio site personalizado para fornecer esses serviços à comunidade de desenvolvimento. Para saber mais sobre os portais do desenvolvedor, consulte O que é um portal do desenvolvedor?
As seções a seguir descrevem os principais conceitos que você precisa entender antes de solucionar problemas com o portal do desenvolvedor.
Como o SmartDocs funciona
Uma especificação da OpenAPI (JSON ou YAML) ou WADL que descreve sua API pode ser importada para SmartDocs e usada para publicar a documentação de referência da API no portal. A documentação de referência da API aparece automaticamente na guia "APIs" do portal. Os desenvolvedores descobrem a documentação da API pelo portal e podem fazer solicitações de API em tempo real. Como as solicitações de API são originadas de um navegador, o suporte a CORS (compartilhamento de recursos de origem cruzada) é necessário para que elas sejam bem-sucedidas. O suporte a CORS é fornecido pelo proxy "smartdocs" no Edge (na organização "VALIDATE") que atua como proxy para todas as solicitações do SmartDocs para o endpoint pretendido. O proxy "smartdocs" é criado quando você instala o SmartDocs.
Exemplo:
O URL do proxy do SmartDocs é exposto como uma propriedade configurável em "Configuração" -> "SmartDocs" -> "URL do proxy do SmartDocs". Talvez seja necessário modificar esse URL se a API estiver em uma rede privada e as solicitações de API em tempo real usando o SmartDocs do portal falharem.
Como o portal do desenvolvedor se comunica com Edge
O portal do desenvolvedor armazena e recupera a maioria das informações exibidas no Edge incluindo SmartDocs, desenvolvedores, produtos e apps de desenvolvedor. As informações da organização do Edge e as credenciais do devadmin podem ser configuradas usando o comando de menu "Configuração" -> "Devportal".
Para mais informações, consulte Comunicação entre o portal e o Edge.