Encontrar

Artículo

Julio Esquerdo · 12 feb, 2025 Lectura de 5 min

#Concurso #InterSystems API Manager (IAM) #JSON #Python #API REST #InterSystems IRIS

Utilizando Flask, API REST e IAM com o InterSystems IRIS

Parte 3 – IAM

O InterSystems API Manager (IAM) é um componente que permite monitorar, controlar e gerir o tráfego de APIs baseadas em HTTP. Ele também atua como uma API gateway entre aplicações e servidores InterSystems IRIS.

O documento publicado em https://docs.intersystems.com/irislatest/csp/docbook/DocBook.UI.Page.cls?KEY=PAGE_apimgr traz as informações sobre o produto.

Já o documento https://docs.intersystems.com/components/csp/docbook/DocBook.UI.Page.cls?KEY=CIAM3.0_install traz todas as informações para a instalação e configuração do IAM.

Após instalar o IAM vamos ativar o mesmo e configurar um serviço, rota e plugin para criar um Rate Limiting para a nossa API REST.

Primeiro, após instalar o IAM vamos ativa-lo conforme definido na documentação:

Uma vez ativado o IAM vamos abrir a interface de administração para criar o serviço, rota e plugin necessários. Para isso no navegador acessamos o servidor na porta 8002:

Nesta tela vemos as opções de manutenção de serviço, rota e plugins, que são as tarefas que vamos realizar. Primeiro vamos criar o serviço para atender a nossa API REST. Clique no menu lateral em Services e na sequencia em New Service:

Informe o nome (cliente-service) e na opção Add using URL informe em URL o caminho da API (http://192.168.0.13/iris/rest/servico/cliente nonosso exemplo). Clique em Create e o serviço estará criado:

Agora vamos criar a rota. No menu lateral clique em Routes e a seguir em New Route.

Selecione o serviço que criamos, informe um nome para a rota (cliente-route por exemplo), informe os protocolos que poderão ser usados (http e https), informe o host (192.168.0.13) e os métodos (GET,PUT,POST,DELETE). Clique no link Add Path e informe o path para esta rota (/api/cliente). Clique em Create e a rota estará criada:

Agora vamos criar o plugin de rate Limiting. Este plugin limita o número de solicitações que um usuário pode fazer em um determinado período de tempo. Para isso volte ao menu lateral e clique em Plugins e na sequencia em New Plugin. Na caixa de pesquisa digite Rate e veja os plugins listados:

Selecione o plugin Rate Limiting Advanced. Será a presentada a tela de configuração do plugin:

Na tela de configuração mude a opção para Scoped. Selecione o serviço que criamos. Informe a quantidade de acessos em Config.Limit (5 por exemplo) e o tempo de intervalo em Config.Window.Size (60 por exemplo). Mude Config.Strategy para local e clique em Create. Pronto. Nosso plugin está criado e já está trabalhando:

Agora vamos precisar fazer uma alteração no nosso código python para consumir a nossa API através do IAM. Para isso vamos mudar o endereço da URL da API para o endereço que criamos na Rota do IAM:

API_URL = “http://192.168.0.13/iris/rest/servico/cliente” - Código Original

API_URL = “http://192.168.0.13:8000/api/cliente“ - Nova URL passando pelo IAM

Reative o servidor do Flask e volte a página da aplicação. Desta vez dê uma sequencia de refresh (F5) de forma a chamar a API diversas vezes. Veja que na 6^ª chamada da API temos uma falha:

A nossa aplicação não está preparada para tratar a falha no HTTP status. Vamos fazer alguns ajustes. Primeiro vamos criar na pasta templates uma página de erro chamada erro.html:

<!DOCTYPE html>

<html lang="pt-br">

<head>

<meta charset="UTF-8">

<meta name="viewport" content="width=device-width, initial-scale=1.0">

<title>Erro</title>

</head>

<body>

<h1>Ocorreu um erro!</h1>

<p>Código de erro: {{ status_code }}</p>

<p>Mensagem de erro: {{ error_message }}</p>

</body>

</html>

Vamos voltar ao código em python e fazer um ajuste para capturar o erro. No trecho que chamaos a montagem da página de index vamos tratar um HTTP code diferente de 200:

Onde temos o seguinte código no rota “/”:

data = response.json()

lista = data["clientes"]

return render_template("index.html", registros=lista)

Mudamos para:

if response.status_code == 200:

data = response.json()

lista = data["clientes"]

return render_template("index.html", registros=lista)

else:

return render_template('erro.html', status_code=response.status_code, error_message=response.json().get('message', 'Erro desconhecido'))

Vamos reiniciar a aplicação Flask e mais uma vez vamos chamar a API diversas vezes. Desta vez vamos receber uma tela de erro tratado:

Podemos então ver que o IAM já está trabalhando, recebendo as requisições e aplicando os plugins configurados. De acordo com nossa configuração o IAM restringiu o acesso a API devolvendo um HTTP status 429 conforme configurado no plugin.

Voltando a tela de administração no IAM podemos ver já algumas informações sobre o consumo do serviço:

Podemos ver a quantidade de requisições que foram feitas ao serviço por HTTP Status por exemplo. Podemos também mudar a forma de visualização do gráfico:

O IAM é uma ferramenta poderosa que agrega diversas vantagens ao Iris e permite uma série de ações com seus plugins. O IAM pode ser um aliado poderoso para a publicação de serviços.

Até a próxima!

Comentarios (0)1

Inicie sesión o regístrese para continuar

Artículo

Julio Esquerdo · 12 feb, 2025 Lectura de 6 min

#Concurso #InterSystems API Manager (IAM) #JSON #Python #API REST #InterSystems IRIS

Utilizando Flask, API REST e IAM com o InterSystems IRIS

Parte 2 – Aplicativo Flask

Flask é um microframework de desenvolvimento web escrito em Python. Ele é conhecido por ser simples, flexível e permitir o desenvolvimento rápido de aplicações.

A instalação do Flask é muito simples. Depois de ter o python instalado corretamente no seu sistema operacional precisamos instalar a biblioteca flask com o comando pip. Para o consumo de API REST é aconselhado o uso da biblioteca requests. O link a seguir traz um guia para a instalação do flask: https://flask.palletsprojects.com/en/stable/installation/

Instalado o flask, vamos então começar com a estrutura do nosso aplicativo. Vamos criar os diretórios e sub-diretórios para acomodar nossos arquivos:

/--+

+-- static

+-- templates

Vamos então seguir essa definição. Por exemplo, em c:\temp vamos criar o diretório flask e abaixo vamos criar os sub-diretórios static e template.

Siga a documentação de instalação e instale e configute o venv. Depois instale a biblioteca flask como o comando pip. A documentação do flask mostra o comando. Lembre-se que você precisa já ter o python instalado.

Depois de instalar a biblioteca flask, instale a biblioteca requests com o pip, da mesma forma que instalou o flask.

No diretório flask vamos colocar nossa aplicação python. A seguir o código da aplicação:

from flask import Flask, render_template, request, redirect, url_for

import requests

from requests.auth import HTTPBasicAuth

app = Flask(__name__)

API_URL = "http://192.168.0.13/iris/rest/servico/cliente"

USERNAME = "_SYSTEM"

PASSWD = "SYS"

# Rota para Listar Registros

@app.route('/')

def index():

response = requests.get(API_URL, auth=HTTPBasicAuth(USERNAME, PASSWD))

data = response.json()

lista = data["clientes"]

return render_template("index.html", registros=lista)

# Rota para Exibir o Formulário de Inclusão

@app.route('/incluir', methods=['GET'])

def incluir():

return render_template("form.html", registro={"id": "", "nome": "", "idade": ""}, acao="Incluir")

# Rota para Criar um Novo Registro

@app.route('/criar', methods=['POST'])

def criar():

dados = {

"nome": request.form["nome"],

"idade": request.form["idade"]

}

requests.post(API_URL, json=dados, auth=HTTPBasicAuth(USERNAME, PASSWD))

return redirect(url_for("index"))

# Rota para Exibir o Formulário de Edição

@app.route('/editar/<int:id>', methods=['GET'])

def editar(id):

response = requests.get(f"{API_URL}/{id}", auth=HTTPBasicAuth(USERNAME, PASSWD))

registro = response.json() if response.status_code == 200 else {"id": "", "nome": "", "idade": ""}

return render_template("form.html", registro=registro, acao="Editar")

# Rota para Atualizar um Registro Existente

@app.route('/atualizar/<int:id>', methods=['POST'])

def atualizar(id):

dados = {

"nome": request.form["nome"],

"idade": request.form["idade"]

}

requests.put(f"{API_URL}/{id}", json=dados, auth=HTTPBasicAuth(USERNAME, PASSWD))

return redirect(url_for("index"))

# Rota para Deletar um Registro

@app.route('/deletar/<int:id>')

def deletar(id):

requests.delete(f"{API_URL}/{id}", auth=HTTPBasicAuth(USERNAME, PASSWD))

return redirect(url_for("index"))

if __name__ == "__main__":

app.run(debug=True)

O código é bem simples, temos as rotas de inclusão, alteração, deleção, uma rota para listar os registros existentes e dar acesso as opções de manutenção, e os formulários de inclusão e alteração.

Agora vamos para o sub-diretório static. Nele vamos colocar nosso arquivo de CSS style.css:

body {

;

text-align: center;

margin: 20px;

}

table {

width: 60%;

margin: auto;

border-collapse: collapse;

}

th, td {

border: 1px solid black;

padding: 8px;

}

a {

text-decoration: none;

color: blue;

}

E no sub-diretório templates vamos colocar nossos arquivos HTML index.html e form.html:

index.html

<!DOCTYPE html>

<html lang="pt">

<head>

<meta charset="UTF-8">

<title>CRUD Flask</title>

<link rel="stylesheet" href="{{ url_for('static', filename='style.css') }}">

</head>

<body>

<h2>Lista de Registros</h2>

<a href="{{ url_for('incluir') }}">Adicionar Novo</a>

<table border="1">

<tr>

<th>ID</th>

<th>Nome</th>

<th>Idade</th>

<th>Ações</th>

</tr>

{% for reg in registros %}

<tr>

<td>{{ reg.id }}</td>

<td>{{ reg.nome }}</td>

<td>{{ reg.idade }}</td>

<td>

<a href="{{ url_for('editar', id=reg.id) }}">Editar</a> |

<a href="{{ url_for('deletar', id=reg.id) }}" onclick="return confirm('Tem certeza?')">Excluir</a>

</td>

</tr>

{% endfor %}

</table>

</body>

</html>

form.html

<!DOCTYPE html>

<html lang="pt">

<head>

<meta charset="UTF-8">

<title>{{ acao }} Registro</title>

</head>

<body>

<h2>{{ acao }} Registro</h2>

<form method="POST" action="{{ url_for('criar' if acao == 'Incluir' else 'atualizar', id=registro.id) }}">

<label>Nome:</label>

<input type="text" name="nome" value="{{ registro.nome }}" required><br>

<label>idade:</label>

<input type="text" name="idade" value="{{ registro.idade }}" required><br>

<button type="submit">{{ acao }}</button>

</form>

<a href="{{ url_for('index') }}">Voltar</a>

</body>

</html>

Para executar a aplicação basta ir para o diretório onde estamos com nossa aplicação python (no nosso caso, c:\temp\flask), ativar o venv (ambiente virtual) e executar a aplicação:

Agora podemos acessar nossa aplicação acessando a porta 5000 com um navegador:

Clicando no link Adicionar Novo temos a tela de inclusão de registros na nossa classe:

Voltando a tela de index, selecionado Alterar em algum registro, temos a tela de alteração:

E, novamente voltando a tela de index, clicando em Excluir vamos para a confirmação da deleção:

Com isso terminamos esta parte do artigo. Já temos a nossa classe persistente criada, a API REST publicada e uma aplicação em flask consumindo esta API com a biblioteca requests para realizar a manutenção básica (CRUD) nos nossos registros.

Até a próxima!

Comentarios (0)1

Inicie sesión o regístrese para continuar

Resumen

Anastasia Dyubaylo · 12 feb, 2025

#Comunidad de Desarrolladores Oficial #Resumen