F01

Processamento dos dados coletados dos portais de transparência dos municípios do Estado de Minas Gerais

Este repositório apresenta códigos dos validadores e da API REST JSON que disponibiliza os resultados.

API de Consultas aos Resultados dos Validadores

Iniciar a API localmente

A primeira etapa para poder instalar o sistema é realizar o donwload de seu código-fonte. Para isso, utilize as ferramentas do GitHub para baixar o repositório localmente. Em seguida, é necessário um virtualenv ou uma máquina apenas com Python 3.7+ com requirements descritos em "requirements.txt"

Dentro de /service rode o comando:

python app.py <numero_de_porta>

A porta adotada será <numero_de_porta> http://localhost:<numero_de_porta> (definida como argumento da linha de comando).

Obs: Os itens estão listados em 'lista_exigencias.csv'

Consulta de todos os itens de um municipio:

http://localhost:5013/api/{municipio}

• Método GET

• Entrada: ID do municipio (código IBGE).

• Resposta: Formato JSON com a resposta de todos os itens (possívelmente de 1 até 103).

Consulta a um item específico de um municipio:

http://localhost:5013/api/{municipio}/{nº_do_item}

• Método GET

• Entrada - Parâmetros:

1. ID do municipio (código IBGE)
2. O número do item, algum dos listados em 'lista_exigencias.csv'.

• Resposta: Formato JSON com a resposta do item específico.

Resposta de um item:

A resposta JSON de um item possui dois campos: 'codigo' e 'justificativa', conforme a seguir:

codigo	justificativa	contexto

| MUNICIPIO_NAO_DISPONIVEL | "Municipio inválido ou não abordado" | API | | ITEM_NAO_DISPONIVEL | "Item ainda não validado" | Validação | | ERRO_VALIDADO | "Validação informou que o item coletado nao atende aos requisitos" | Validação | | OK_VALIDADO | "Item validado com sucesso" | Validação |

É importante destacar que, no caso da resposta ser OK_VALIDADO ou ERRO_VALIDADO (respostas da fase de validação) a justificativa poderá variar, apresentando uma explicação específica sobre a validação do item solicitado.

Exemplo

• Requisição (Município Muriaé, item 7 (Link de respostas a perguntas mais frequentes da sociedade.):

http://localhost:5013/api/3143906/7 

• Resposta:

{
  "7": {
    "codigo": "OK_VALIDADO", 
    "justificativa": "Item validado com sucesso. Explain - Quantidade de arquivos analizados: 5. Quantidade de aquivos que possuem referência a Perguntas Frequentes: 5"
  }
}

Documentação

Com a biblioteca Flask-Swagger, o endpoint padrão para acessar a documentação gerada pelo Swagger é /apidocs. Portanto, para visualizar a documentação, você deve acessar o seguinte URL:

http://.../apidocs/