Criar ou estender uma interface de CAPI

  • Versão de lançamento: Xanadu
  • Atualizado 1 de ago. de 2024
  • 1 min. de leitura

    • Você pode criar uma nova interface de CAPI ou estender uma existente adicionando novas operações.

    Antes de Iniciar

    • Função necessária: admin
    • Revise APIs de CAPI padrão e certifique-se de que o provedor e o produto que você deseja criar não existam.
    • Familiarize-se com a API do provedor de nuvem para que você saiba como criar chamadas REST para o provedor. Se você não estiver familiarizado com os cabeçalhos, requisitos de autenticação, endpoint e dados que pode passar para a API do provedor, não poderá criar seus próprios componentes de CAPI.

    Por Que e Quando Desempenhar Esta Tarefa

    Normalmente, você pode usar as interfaces padrão fornecidas na aplicação Cloud Provisioning and Governance. Para criar uma interface personalizada, baseie-a em uma existente que seja semelhante.

    Procedimento

    1. Em Portal de Administração de Nuvem, navegue até Design > API em Nuveme, em seguida, clique na guia Interface.
    2. Clique em Nova.
    3. Na janela Adicionar interface de nuvem, insira um nome para a interface, uma descrição útil e selecione a categoria mais relevante à qual a interface de API deve pertencer.

      Este exemplo mostra uma interface para armazenamento do Azure:

      Interface de armazenamento do Azure

    4. Na lista relacionada Operações de interface de CAPI, clique em Novo.

      Cada operação criada corresponde a uma chamada de REST API diferente.

    5. Forneça um nome para a operação que corresponda à API que você deseja chamar no provedor.

      Por exemplo, você pode criar uma operação chamada CreateContainer que corresponde à operação Criar contêiner no Azure.

      Criar contêiner

    6. Clique com o botão direito do mouse no cabeçalho e selecione Salvar.
    7. Na lista relacionada Parâmetros de operação de interface, clique em Novo.
    8. Crie um parâmetro de que a operação precisa, conforme definido pela documentação da REST API do provedor de nuvem.

      Se você não souber os parâmetros, a operação falhará. No exemplo de armazenamento do Azure, a operação CreateContainer deve ter o nome do contêiner que é chamado aqui de ContainerName.

      Nome do contêiner

    9. Clique em Enviar.
    10. Adicione quantos parâmetros forem necessários para a operação e, em seguida, adicione todas as operações necessárias.

    O que Fazer Depois

    Criar uma API de CAPI