Introdução e configuração

Use o recurso de integração da API REST, que está habilitado por padrão no Service Definition Framework.

Recursos compatíveis

A integração da API REST suporta os seguintes métodos e formatos de carga útil do HTTP.

Métodos suportados do ` HTTP `

  • RECEBER
  • POSTAR
  • PUT
  • EXCLUIR
  • PATCH

Formatos de carga útil compatíveis

  • JSON
  • XML
Importante:

Configuração do suporte a JSON

Para usar entrada/saída JSON nos fluxos de serviço, é necessário configurar uma das seguintes opções:

Opção 1 : Adicione o serviço à propriedade `wrap` do JSON:

yfs.xmljson.wrapjson.forflows=YourServiceName,AnotherService

Opção 2 : Configurar o serviço como uma ferramenta MCP. O JSON é o formato padrão das Ferramentas MCP.

Apenas o componente API, o ` Kafka ` e o emissor/receptor JMS oferecem suporte a JSON nos fluxos de serviço.

Configuração básica

Você pode resolver dinamicamente os seguintes elementos de configuração:

  • Cabeçalhos
  • Parâmetros de consulta
  • URL segmentos
  • OAuth configurações como ID do cliente, segredo do cliente e OAuth URL

utilizando:

  • Propriedades do sistema - compatível com todos os campos, incluindo OAuth
  • XML XPath - para cabeçalhos, parâmetros e URL
  • JSONPath - para cabeçalhos, parâmetros e URL
  • Contexto da solicitação recebida — cabeçalhos e parâmetros de consulta
Observação: os campos de configuração do ` OAuth `, como ID do cliente, segredo e ` URL `, podem ser resolvidos usando ${property} a sintaxe.

Elementos de configuração

Tabela 1. Elementos de configuração da API REST
Elemento Propósito
URL Terminal de REST
Método Método de HTTP
Cabeçalhos Cabeçalhos de solicitação customizada
Parâmetros Parâmetros de consulta
Autenticação OAuth / Nenhum (menu suspenso)
Tempo limite Tempo limite da API - opcional