Passo 6: anexe uma política

Esta página aplica-se ao Apigee e ao Apigee Hybrid.

Veja a documentação do Apigee Edge.

As políticas do Apigee podem transformar formatos de mensagens, aplicar o controlo de acesso, chamar serviços remotos, autorizar utilizadores, examinar o conteúdo das mensagens para detetar potenciais ameaças e muito mais. Para mais informações, consulte o artigo O que é uma política?

Os pontos finais de proxy e de destino definem um pipeline para o processamento de mensagens de pedidos e respostas, a que se chama fluxos de pedidos e respostas. Os fluxos são fases sequenciais ao longo do caminho de processamento de pedidos da API. As políticas são anexadas em diferentes pontos nos fluxos de mensagens de pedido e resposta como passos de processamento.

Nos passos seguintes, cria uma nova política e anexa-a ao proxy de API no fluxo de resposta PreFlow para garantir que a política é aplicada antes de qualquer outro processamento. A política XMLtoJSON usada neste tutorial converte a carga útil da mensagem de resposta da API de XML para JSON.

  1. Crie uma política XMLtoJSON.
    1. Expanda o pacote de proxy da API helloworld, posicione o cursor sobre a pasta policies e clique em Ícone de criação para nova política.

      Ficheiro de ponto final de destino default.xml

      É aberto o assistente Criar política.

    2. Selecione Mediação como categoria de política.
    3. Selecione XML para JSON como o tipo de política.
    4. Introduza XMLtoJSON como o nome da política e clique em Enter.

      A política é adicionada à pasta /policies do proxy de API e aberta no editor.

    5. Clique em XMLtoJSON.xml para editar a política. Defina os elementos <OutputVariable> e <Source> como response e guarde as alterações.
      <?xml version="1.0" encoding="UTF-8" standalone="yes"?>
      <XMLToJSON async="false" continueOnError="false" enabled="true" name="XMLtoJSON">
          <DisplayName>XMLtoJSON</DisplayName>
          <Properties/>
          <Format>yahoo</Format>
          <OutputVariable>response</OutputVariable>
          <Source>response</Source>
      </XMLToJSON>
  2. Anexe a política ao ponto final do proxy predefinido.
    1. Expanda a pasta proxies no pacote de proxy da API helloworld e clique em default.xml para abrir o ficheiro no editor.
    2. Adicione um elemento <Step> que faça referência à política XMLtoJSON ao fluxo <Response> no proxy de API <PreFlow>:
      <ProxyEndpoint name="default">
         <PreFlow name="PreFlow">
            <Request>
               <Step>
                  <Name>verify-api-key</Name>
               </Step>
               <Step>
                  <Name>remove-query-param-apikey</Name>
               </Step>
               <Step>
                  <Name>impose-quota</Name>
               </Step>
            </Request>
            <Response>
               <Step>
                  <Name>XMLtoJSON</Name>
               </Step>
            </Response>
         </PreFlow>
       ...
      </ProxyEndpoint>
    3. Guarde as alterações ao ficheiro.
  3. Para voltar a implementar o ambiente, posicione o cursor sobre a pasta do ambiente dev e clique em Ícone de implementação para um ambiente.

    O ícone Implementar é apresentado quando posiciona o cursor sobre a pasta do ambiente de desenvolvimento

  4. Quando lhe for pedido que selecione um pacote de testes para exportar, clique em Implementar sem um pacote de testes, porque o pacote de testes já foi exportado.

    Pedido para exportar o pacote de teste

  5. Chame a sua API no separador Terminal.
    curl 0:8998/helloworld?apikey=ZQA5euYtNeJ7ZCGCJMpvd6F2BZOmxOzY

    A resposta XML é convertida em JSON da seguinte forma:

    {
      "root": {
        "city": "San Jose",
        "firstName": "John",
        "lastName": "Doe",
        "state": "CA"
      }
    }

Parabéns! Associou com êxito a política XMLtoJSON ao seu proxy de API!

Em seguida, vai implementar a API como um arquivo num ambiente do Apigee para testes de integração e lançamento de produção.

1 2 3 4 5 6 (NEXT) Passo 7: implemente num ambiente do Apigee 8