Suporte a OpenAPI na etapa REST

  • Versão de lançamento: Zurich
  • Atualizado 31 de jul. de 2025
  • 3 min. de leitura

    • Preencha os campos da etapa REST e as entradas de ação com informações importadas de uma especificação de OpenAPI. Importe especificações fornecendo um URL para YAML ou JSON, ou copiando e colando o conteúdo.

    Benefícios

    O suporte à OpenAPI na etapa REST oferece esses benefícios.

    • Use informações importadas de uma Especificação OpenAPI para configurar operações de etapa REST, métodos HTTP, parâmetros, corpo da solicitação, caminho e e cabeçalhos.
    • Revise as operações de API disponíveis sem sair da interface do Flow Designer.
    • Gere as entradas necessárias para que a etapa REST envie solicitações válidas para um serviço OpenAPI e adicione-as à etapa REST no local correto.
    Nota:
    Sempre revise os valores da etapa REST importados de uma especificação do OpenAPI antes de enviar uma solicitação. Remova parâmetros, cabeçalhos e entradas que a API não requer.

    Entradas geradas

    Quando você importa uma Especificação OpenAPI, o sistema cria todas as entradas necessárias e as adiciona ao formulário de etapa REST quando apropriado. No tempo de execução, o sistema envia uma solicitação REST que contém valores de entrada fornecidos para a ação. Por exemplo, se uma API exigir um parâmetro de nome passado na solicitação, o sistema criará um nome E a adiciona à etapa REST. Quando você adiciona a ação ao fluxo, o nome se torna uma entrada para a ação.

    O sistema mapeia os tipos de dados OpenAPI para Workflow Studio tipos de dados. Por exemplo, se a Especificação OpenAPI exigir um objeto de usuário, o sistema criará um objeto de dados complexo como entrada. Para obter mais informações, consulte Dados complexos .

    Limite de tamanho da especificação

    Por padrão, o sistema pode importar Especificações OpenAPI de até 10 MB. Para aumentar o tamanho da importação, atualize glide.rest.openapi.max_request_sizepropriedade do sistema. O valor máximo é 100 MB.

    Gestão de especificações

    Importe uma especificação OpenAPI selecionando opções na etapa REST. Para obter mais informações, consulte Etapa REST. Importar uma especificação OpenAPI cria um registro na tabela OpenAPIs [sys_openapi]. Você pode exibir ou excluir registros de especificação diretamente desta tabela. Para atualizar uma especificação, exclua-a e importe-a novamente.

    Considerações de design

    Crie uma etapa REST a partir de uma especificação OpenAPI com essas considerações em mente.

    Remova parâmetros desnecessários da etapa REST
    Ao importar uma especificação de OpenAPI, o sistema adiciona todos os parâmetros e cabeçalhos presentes na especificação à etapa REST. Revise os valores da etapa REST final e remova os parâmetros que você não deseja enviar na solicitação. Por exemplo, se a API aceitar cabeçalhos de tipo de conteúdo para JSON e XML, o sistema adicionará ambos os cabeçalhos à etapa REST. Remova um dos cabeçalhos, dependendo do tipo de conteúdo que você deseja receber na resposta.
    Rótulos de entrada fáceis de usar
    Certifique-se de que os rótulos de entrada necessários para a etapa REST sejam claros e compreensíveis. Rótulos limpos permitem que os designers de fluxo entendam facilmente as entradas necessárias ao usar a ação em um fluxo.
    Remova entradas que não exigem configuração do Flow Designer
    Ao importar uma Especificação OpenAPI, o sistema adiciona todas as entradas presentes na especificação à seção de entrada de ação. Remova todas as entradas que não exigem um designer de fluxo para configurar. Por exemplo, se uma variável de etapa REST receber um valor de outra etapa na ação, uma entrada de ação não será necessária.
    Evite mudar a operação da API
    Alterando o valor de Operação de API o campo remove todos os valores dependentes dessa operação. Se você configurar os valores de especificação do OpenAPI no formulário de etapa REST e alterar a operação, o sistema não salvará sua configuração. Os valores inseridos manualmente por um usuário não são afetados.

    Limitações

    Crie uma etapa REST a partir de uma especificação OpenAPI com essas limitações.

    Solicitar tipos de mídia do corpo
    O corpo da solicitação é compatível somente com tipos de mídia JSON e baseados em XML. Se a operação selecionada da Especificação OpenAPI importada contiver um corpo de solicitação com um tipo de mídia diferente, o sistema adicionará uma cápsula de dados do tipo Cadeia de caracteres ao Corpo da solicitação campo.
    Componentes do OpenAPI 3,0

    OpenAPI 3,0 adiciona novos componentes ao Swagger 2,0 para descrever uma API em mais detalhes. O suporte a OpenAPI na etapa REST oferece suporte a alguns, mas não a todos, desses componentes. No momento, a etapa REST não oferece suporte a esses componentes.

    • Objeto de esquema: Oneof, propriedades anyOf
    • Objeto discriminador
    • Objeto de informações: TermsOfService, contato, campos de licença
    • Objeto de exemplo
    • Vincular objeto
    • Objeto de retorno de chamada
    • Objeto do esquema de segurança
    • Objeto de requisitos de segurança
    • Objeto de marcador
    • Objeto de documentação externo
    • Objeto do servidor
    • Extensões de especificação
    • Referências recursivas

    Mais informações sobre esses componentes estão disponíveis na documentação do OpenAPI. Consulte OpenAPI Especificação .