Saiba mais sobre Design de API Personalizada

No Oracle Mobile Hub, você pode criar APIs REST personalizadas que podem ser usadas por seus aplicativos móveis.

Se você for um desenvolvedor de aplicativo móvel, use o API Designer para esboçar e testar os pontos finais definidos e, em seguida, peça a um desenvolvedor de serviço para preencher os detalhes da API (adicionar tipos ou características de recursos, fornecer um esquema e definir o acesso à API e seus pontos finais) e implementá-la em JavaScript. Se você for um desenvolvedor de serviço, use o API Designer para configurar explicitamente uma API completa que você pode testar com dados simulados. Como alternativa, você pode gerar APIs personalizadas de conectores REST ou Fusion Applications sem gravar nenhum código.

Ao contrário das APIs da plataforma Oracle Mobile Hub, que fornecem um conjunto principal de serviços conhecidos, as APIs personalizadas permitem que você use Node.js para codificar qualquer serviço necessário ao seu aplicativo móvel, publicado por meio de uma interface REST. Você pode retransmitir dados usando um conector do Oracle Mobile Hub para um serviço de backend, que transforma dados complexos em payloads compatíveis com dispositivos móveis. Usando APIs personalizadas para criar um catálogo de serviços reutilizáveis, você pode economizar muito tempo que, de outra forma, poderia ser gasto periodicamente recriando e mantendo detalhes de implementação em seus aplicativos móveis.

Sobre o Processo de Design de API

O API Designer orienta você no processo de criação de uma API personalizada.

Você pode criar rapidamente uma versão preliminar da API em apenas algumas etapas:

Adicione o básico (nome da API, o tipo de mídia da mensagem e uma breve descrição).
Defina um ponto final definindo um recurso e pelo menos um método para ele.
Definir a segurança de acesso.
Teste seu ponto final depois de definir pelo menos um recurso.

Você pode criar dados simulados para testar e validar rapidamente um ponto final, mesmo quando não tiver concluído completamente a configuração da API. Ao definir o corpo da mensagem, você pode fornecer valores de espaço reservado para verificar se os dados corretos estão sendo enviados ou retornados.

Para concluir totalmente sua API, use o API Designer para ajudá-lo a adicionar os componentes essenciais para uma API robusta:

Forneça os metadados da API (ou seja, os atributos básicos da API, que são o nome para exibição da API, o nome da API e a descrição curta) ou, se você já tiver um documento RAML que contenha a configuração da sua API, poderá fazer upload dele para o API Designer. Todas as informações (metadados, recursos, métodos e o esquema do corpo da mensagem) são extraídas do documento RAML e carregadas no API Designer, permitindo que você prossiga rapidamente para testar seus pontos finais ou editar sua configuração de API.
Adicione um ou mais recursos raiz e aninhados.
Adicione métodos para agir nos recursos.
Crie um esquema para descrever o corpo dos dados.
Teste seus pontos finais durante o tempo de design com dados de amostra e faça as alterações necessárias.
Permita acesso anônimo à sua API ou especifique quais atribuições podem acessá-la.
Adicione documentação para sua API personalizada

Posteriormente, à medida que cria mais APIs, você pode descobrir que está definindo repetidamente os mesmos métodos e usando os mesmos parâmetros, etc. Você pode reduzir a redundância criando tipos de recursos e características. Se sua API ainda estiver no estado de rascunho, você poderá voltar à sua configuração e adicionar os tipos de recursos e as características que definiu.

Sobre a Geração de APIs Personalizadas para Conectores

O Oracle Mobile Hub pode gerar código personalizado de conectores para estabelecer conexão com serviços externos. Como desenvolvedor de serviço, você pode selecionar um conector do Oracle Fusion Applications ou um conector REST que foi criado com um descritor válido, gerar a API personalizada e usar a API gerada para facilitar a chamada desses serviços das implementações de suas APIs personalizadas ou diretamente de um aplicativo móvel.

Um conector é uma maneira de permitir que um backend móvel se comunique com um serviço externo, como um sistema empresarial ou APIs de terceiros, o que, por sua vez, permite que um aplicativo móvel interaja com as funções desse serviço. Uma API de conector é uma configuração para comunicação com um serviço externo específico para enviar e receber dados.

Como desenvolvedor de serviço, você pode gerar uma API personalizada que exponha os métodos de uma API de conector e forneça uma implementação padrão sem gravar código.

A API personalizada é gerada com um ponto final para cada recurso na API do conector e ela é aberta no API Designer para que você continue especificando detalhes da API, como funções. A implementação padrão, que passa por todas as solicitações provenientes da API personalizada gerada para a API do conector de destino, também é gerada e designada à API gerada. Assim que você tiver designado atribuições à API, se elas forem necessárias para segurança no conector, poderá usar a implementação para testar a API. Você pode fazer download e modificar a implementação e, em seguida, fazer upload dela.

Ser capaz de criar uma API personalizada para um conector significa que é muito mais fácil criar um protótipo que você usa para testar um conector. À medida que você encontra coisas que deseja alterar, pode fazer rapidamente uma alteração no conector e gerar uma nova API e implementação personalizadas. Quando estiver satisfeito, você poderá gerar uma versão final da API e implementação personalizadas.

Desenvolva um conector REST ou um conector do Oracle Fusion Cloud Applications que seja definido usando um descritor.
Gere a API personalizada do conector. Ele é aberto no API Designer, no qual você pode definir uma ou mais atribuições ou especificar a autenticação exigida pela API.
Você pode chamar imediatamente a API gerada a partir do dispositivo móvel. A implementação padrão passa por todas as solicitações provenientes da API gerada para a API do conector de destino.
É provável que você queira fazer download da implementação e modificá-la para moldar os dados retornados.
Talvez você queira revisitar o conector e fazer alterações nos recursos ou no descritor do conector. Se você gerar uma nova API e implementação personalizadas. Se você fizer alterações na API personalizada gerada, essas alterações não serão refletidas no conector. Faça as alterações apropriadas no conector e gere a API e a implementação personalizadas novamente.

Você só pode gerar uma API personalizada para um conector REST ou Oracle Fusion Cloud Applications, que é definido usando um descritor. Não é possível gerar uma API personalizada para outro tipo de conector ou em que o conector REST ou Oracle Fusion Cloud Applications não tenha um descritor.

Se quiser enviar dados de formulários em várias partes ou usar o objeto de opções http, talvez seja necessário substituir o método callConnector na implementação pelo seu próprio código.

APIs de Conector REST

Você pode criar APIs de conector para estabelecer conexão com serviços REST externos. Em seguida, você pode chamar essas APIs de conector nas implementações de suas APIs personalizadas.

Como as APIs do Conector REST Funcionam

Uma API de conector REST é uma API intermediária para chamar pontos finais REST em sistemas corporativos ou APIs de terceiros. A API do conector assume a forma de uma configuração que oferece aos seus aplicativos uma maneira padrão de se conectar a esses serviços REST e aproveitar a segurança, o diagnóstico e outros recursos fornecidos pelo Oracle Mobile Hub.

O conector comunica e transmite informações entre o cliente e o servidor usando o protocolo HTTPS. As informações transmitidas podem estar na forma de XML ou JSON (mas apenas em JSON para serviços baseados em descritores Swagger).

O assistente de API do Conector REST orienta você na criação de APIs do conector REST, desde a especificação de um serviço remoto e a definição de políticas de segurança até o teste de seus pontos finais.

Por que usar conectores em vez de chamadas diretas para recursos externos?

O uso de uma API de conector REST oferece os seguintes benefícios ao fazer chamadas diretas do código do aplicativo para recursos externos:

Permite conexão declarativa simplificada e configuração de política.
Com um descritor Swagger, determina os recursos disponíveis e cria pontos finais para você.
Fornece informações de diagnóstico extensas porque elas estão totalmente integradas à estrutura de diagnóstico do Oracle Mobile Hub. Quaisquer chamadas REST de saída feitas por meio de APIs de conector são registradas, o que ajuda muito na depuração.
Permite rastreamento e análise do uso remoto da API.
Permite que você defina a interação com o serviço no design time ao testar a validade de seus pontos finais para que os termos dessa interação não dependam da entrada do usuário no runtime. Isso protege o sistema final e seu backend móvel contra danos.
Fornece uma abordagem de design consistente entre vários tipos de conector para interagir com serviços externos.
Com qualquer alteração na interface de um serviço, você pode lidar com todas as atualizações, testes e migração necessários em um só lugar.