Criando uma API REST

Para criar uma API REST no IBM® App Connect Enterprise, você pode definir os modelos, recursos e operações no Editor de API REST ou no editor OpenAPI. Como alternativa, você pode usar o Kit de Ferramentas do IBM App Connect Enterprise para importar um documento Swagger ou um documento OpenAPI 3.0 que descreva os recursos e as operações que você deseja na API REST.

Sobre esta tarefa

Ambos os métodos para criar uma API REST possuem vantagens, e o método mais apropriado depende de suas circunstâncias.

Criando uma API de REST do zero usando especificações do Swagger

Você pode usar o editor de API REST integrado ao Kit de Ferramentas do IBM App Connect Enterprise para criar uma API REST do zero. O editor da API REST permite criar graficamente uma API REST definindo os recursos, operações e parâmetros para essa API REST. É possível também usar o editor da API REST para definir modelos que representam a estrutura dos corpos de resposta e solicitação JSON para as operações na API REST. Os modelos que você definir com o editor da API REST podem então ser usados pelo editor de mapeamento de dados gráficos para implementar as operações na API REST.

O editor da API REST cria e modifica um documento Swagger que esteja em conformidade com a versão 2.0 da especificação Swagger. O documento do Swagger pode ser usado com o editor de Mapeamento de Dados Gráficos para implementar operações na API de REST, bem como uma ampla gama de ferramentas externas. Por exemplo, Swagger UI, Swagger Codegen e IBM API Management. No entanto, o editor da API REST não suporta a especificação Swagger integral e não pode ser usado para configurar algumas propriedades, tais como os atributos de validação, em objetos no documento Swagger.

Use o editor da API REST para criar uma API REST a partir do zero nas seguintes circunstâncias:
  • Você tem conhecimento limitado ou nenhum conhecimento da especificação Swagger.
  • Você prefere usar as ferramentas gráficas que são integradas ao IBM Integration Toolkit, em vez de usar um editor externo para criar um documento Swagger.

Criando uma API REST a partir do zero usando especificações OpenAPI 3.0

Você pode usar o editor OpenAPI, integrado ao IBM App Connect Enterprise Toolkit, para criar uma API REST do zero. Ao usar o editor OpenAPI, você pode criar graficamente uma API REST definindo os recursos, as operações e os parâmetros dessa API REST. Você também pode usar o editor OpenAPI para definir modelos que representem a estrutura dos corpos das solicitações e respostas JSON para as operações da API REST. Os modelos definidos no editor de mapeamento de dados ( OpenAPI ) podem então ser utilizados pelo editor de mapeamento gráfico de dados (Graphical Data Mapping) para implementar as operações na API REST.

O editor OpenAPI cria e modifica um documento OpenAPI 3.0 . O documento OpenAPI 3.0 pode ser usado com o editor de Mapeamento de Dados Gráficos para implementar operações na API REST.

Use o editor OpenAPI para criar uma API REST a partir do zero usando as especificações OpenAPI 3.0 nas seguintes circunstâncias:
  • Você tem limitado ou nenhum conhecimento da especificação OpenAPI 3.0 .
  • Você prefere usar as ferramentas gráficas que são integradas ao IBM Integration Toolkit, em vez de usar um editor externo para criar um documento OpenAPI 3.0 .

Criando uma API de REST importando um documento do Swagger

É possível usar um editor externo, como o Swagger Editor, para criar um documento Swagger que define a API REST que você deseja implementar. Você pode então criar uma API REST importando esse documento Swagger com o IBM App Connect Enterprise Toolkit. Todos os recursos, operações e parâmetros são carregados a partir do documento Swagger e podem ser visualizados no editor de API REST do IBM App Connect Enterprise Toolkit. Os modelos também são carregados a partir do documento Swagger e esses modelos podem, então, ser usados com o editor de mapeamento de dados gráficos para implementar operações na API REST.

O editor da API REST no IBM Integration Toolkit também permite que você modifique a API REST, como adicionar novos recursos, e modifica o documento Swagger importado automaticamente. No entanto, o editor da API REST não suporta a especificação Swagger integral, e pode não ser capaz de exibir ou modificar o conteúdo completo de um documento Swagger importado.

Crie uma API REST importando um documento Swagger nas seguintes circunstâncias:
  • Você tem um bom conhecimento da especificação Swagger e cria um documento Swagger para a API REST que pretende implementar no ` IBM App Connect Enterprise `.
  • Um membro da sua equipe, como um designer de API, está criando um documento Swagger para a API REST que você planeja implementar no IBM App Connect Enterprise.
  • Você requer o uso de todas as propriedades na especificação Swagger, por exemplo, os atributos de validação como maxLength, uniqueItens e allOf, que estão disponíveis quando você define modelos.

Criando uma API REST importando um documento OpenAPI 3.0

Você pode usar um editor externo para criar um documento OpenAPI 3.0 que define a API REST que você deseja implementar. Você pode então criar uma API REST importando este documento OpenAPI 3.0 usando o IBM App Connect Enterprise Toolkit. Todos os recursos, operações e parâmetros são carregados a partir do documento OpenAPI 3.0 e podem ser visualizados no editor OpenAPI do IBM App Connect Enterprise Toolkit. Os modelos também são carregados a partir do documento OpenAPI3.0, e esses modelos podem então ser usados com o editor de mapeamento gráfico de dados para implementar operações na API REST.

O editor OpenAPI no IBM Integration Toolkit também permite que você modifique a API REST, como adicionar novos recursos, e modifica o documento importado OpenAPI 3.0 automaticamente.

Crie uma API de REST importando um documento OpenAPI nas seguintes circunstâncias:
  • Você possui um bom conhecimento da especificação OpenAPI 3.0 e cria um documento OpenAPI 3.0 para a API REST que pretende implementar em IBM App Connect Enterprise.
  • Um membro separado da sua equipe, como um Designer de API, está criando um documento OpenAPI 3.0 para a API REST que você planeja implementar no IBM App Connect Enterprise.
  • Você requer o uso de todas as propriedades na especificação OpenAPI 3.0 .

Procedimento

Siga as etapas de uma das tarefas a seguir para criar uma API REST no IBM App Connect Enterprise :

O que fazer em seguida