Você está vendo a documentação do Apigee Edge.
Acesse a
documentação da Apigee X. informações
Como provedor de API, você precisa de uma maneira de expor APIs, informar 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 e fornecer esses serviços para sua comunidade de desenvolvedores. Para saber mais sobre portais de desenvolvedores, 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
É possível importar uma especificação OpenAPI (JSON ou YAML) ou WADL para o SmartDocs e publicar a documentação de referência da API no seu portal. A documentação de referência da API aparece automaticamente na guia APIs do seu portal. Os desenvolvedores descobrem a documentação da API por meio do portal e podem fazer solicitações de API em tempo real. Como as solicitações de API se originam de um navegador, o compartilhamento de recursos entre origens (CORS, na sigla em inglês) é necessário para que elas sejam bem-sucedidas. O suporte ao CORS é fornecido pelo proxy "smartdocs" no Edge (na organização "VALIDATE"), que atua como o 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 particular e as solicitações ativas que usam o SmartDocs do portal estiverem falhando.
Como o portal do desenvolvedor se comunica com o Edge
O portal do desenvolvedor armazena e recupera a maioria das informações exibidas do Edge, incluindo Smartdocs, desenvolvedores, produtos e apps de desenvolvedores. É possível configurar as informações da organização de borda e as credenciais de devadmin usando o comando de menu "Configuração" -> "Devportal".
Para mais informações, consulte Como estabelecer comunicação entre o portal e o Edge.