Criação de um plug-in
O APIG fornece recursos de extensão flexíveis para APIs por meio de plug-ins.
Diretrizes para o uso de plug-ins
- Uma API pode ser vinculada a apenas um plug-in do mesmo tipo.
- Os plug-ins são independentes das APIs. Um plug-in entra em vigor para uma API somente depois que eles são vinculados um ao outro. Ao vincular um plug-in a uma API, você deve especificar um ambiente no qual a API foi publicada. O plug-in entra em vigor para a API apenas no ambiente especificado.
- Depois de ligar um plug-in a uma API, desvincular o plug-in da API ou atualizar o plug-in, não é necessário publicar a API novamente.
- Colocar uma API off-line não afeta os plug-ins vinculados a ela. Os plug-ins ainda estarão vinculados à API se a API for publicada novamente.
- Os plug-ins vinculados a APIs não podem ser excluídos.
Criação de um plug-in
- Acesse o console de gerenciamento.
- Clique em no canto superior esquerdo e selecione uma região.
- Clique em no canto superior esquerdo e escolha API Gateway.
- No painel de navegação, escolha Dedicated Gateways. Em seguida, clique em Access Console no canto superior direito de um gateway dedicado.
- No painel de navegação, escolha API Publishing > Plug-ins.
- Clique em Create Plug-in.
Na caixa de diálogo Create Plug-in, configure as informações do plug-in.
Tabela 1 Configuração do plug-in Parâmetro
Descrição
Plug-in Name
Nome do plug-in que você deseja criar. Recomenda-se que você digite um nome com base em certas regras de nomenclatura para facilitar a identificação e a pesquisa.
Plug-in Type
Tipo do plug-in, que determina os recursos de extensão do plug-in.
- CORS: especifica cabeçalhos de solicitação de simulação e cabeçalhos de resposta e cria automaticamente APIs de solicitação de simulação para acesso à API de origem cruzada.
- HTTP Response Headers: permite personalizar cabeçalhos de resposta HTTP que serão exibidos em uma resposta da API.
- Request throttling: limita o número de vezes que uma API pode ser chamada dentro de um período de tempo específico. A limitação baseada em parâmetro, básica e excluída é suportada.
Plug-in Content
Conteúdo do plug-in, que pode ser configurado em um formulário ou usando um script.
O conteúdo do plug-in varia dependendo do tipo de plug-in:
Description
Descrição do plug-in.
- Clique em OK.
Depois de criar o plug-in, vincule-o à API para a qual o plug-in entrará em vigor.
Vinculação de um plug-in a uma API
- No painel de navegação, escolha API Publishing > APIs.
- Clique no nome da API de destino para acessar a página de detalhes da API.
- Na página de guia Plug-ins, clique em Bind.
- Na caixa de diálogo Bind Plug-in, selecione um ambiente e tipo de plug-in e selecione o plug-in a ser vinculado.
- Clique em OK.