queryfier-sample

Como testar

Baixe o projeto querify do github.com (ele não está em repositório maven);

git clone https://github.com/chicojfp/querify.git

Compile e instale o projeto:

cd querify
mvn clean package install 

cd ..

Baixe o projeto queryfier-sample do github.com (ele não está em repositório maven);

git clone https://github.com/chicojfp/queryfier-sample.git

Compile e instale o projeto:

cd queryfier-sample
mvn clean package exec:exec 

Execute o Projeto e deixe executando.

Será iniciado um servidor web na porta 8080. Serão disponibilizados 3 serviços:

• /cities
• /stater
• /people

Todos aceitam os métodos GET, POST, PUT, PATCH e DELETE.

A solução utilizar - parcialmente - o padrão JSON+PATCH para atualização de dados.

curl -H "Content-Type: application/json" -X GET http://localhost:8080/states/ -# | python -m json.tool

curl -H "Content-Type: application/json" -X GET http://localhost:8080/cities/ -# | python -m json.tool

curl -H "Content-Type: application/json" -X GET http://localhost:8080/people/ -# | python -m json.tool

Exemplos de Uso:

Adicionar pessoas

curl -d '{ "name":"Brasileiro de Brito"}' -H "Content-Type: application/json" -X POST http://localhost:8080/people
curl -d '{ "name":"Brasiliense"}' -H "Content-Type: application/json" -X POST http://localhost:8080/people
curl -d '{ "name":"Pernambucano Pitombeiras"}' -H "Content-Type: application/json" -X POST http://localhost:8080/people
curl -d '{ "name":"Paranaense Pereira"}' -H "Content-Type: application/json" -X POST http://localhost:8080/people
curl -d '{ "name":"Paraense de Paula"}' -H "Content-Type: application/json" -X POST http://localhost:8080/people
curl -d '{ "name":"Capixaba de Castro"}' -H "Content-Type: application/json" -X POST http://localhost:8080/people

curl -H "Content-Type: application/json" -X GET http://localhost:8080/people

Adicionar Estados:

curl -d '{ "name":"PR", "country":"1", "capital":"1"}}' -H "Content-Type: application/json" -X POST http://localhost:8080/states
curl -d '{ "name":"PA", "country":"1", "capital":"1"}}' -H "Content-Type: application/json" -X POST http://localhost:8080/states
curl -d '{ "name":"ES", "country":"1", "capital":"1"}}' -H "Content-Type: application/json" -X POST http://localhost:8080/states

curl -H "Content-Type: application/json" -X GET http://localhost:8080/states

Alterar um campo dos Estados recém adicionados. É utilizado o padrão json+patch que o corpo do PATCH recebe uma lista de objetos com os padrões:

• op: Indica a operação a ser realizada. Pode ser add, remove, move (Não suportada);
• from: Indica o campo - path jason - que deve ser alterado na requisição;
• patch: Valor a ser aplicado (ou para o qual deve ser aplicado).

curl -d '[{"op":"add", "from":"/governor", "patch":"6"}]' -H "Content-Type: application/json" -X PATCH http://localhost:8080/states/3

curl -d '[{"op":"add", "from":"/governor", "patch":"7"}]' -H "Content-Type: application/json" -X PATCH http://localhost:8080/states/4

curl -d '[{"op":"add", "from":"/governor", "patch":"8"}]' -H "Content-Type: application/json" -X PATCH http://localhost:8080/states/5

Adiciona algumas capitais:

curl -d '{"name":"Belém", "state":"4"}' -H "Content-Type: application/json" -X POST http://localhost:8080/cities

curl -d '{"name":"Curitiba", "state":"3"}' -H "Content-Type: application/json" -X POST http://localhost:8080/cities

curl -d '{"name":"Vitória", "state":"5"}' -H "Content-Type: application/json" -X POST http://localhost:8080/cities

Altera os estados adicionados com as capitais corretas:

curl -d '[{"op":"add", "from":"/capital", "patch":"7"}]' -H "Content-Type: application/json" -X PATCH http://localhost:8080/states/4

curl -d '[{"op":"add", "from":"/capital", "patch":"6"}]' -H "Content-Type: application/json" -X PATCH http://localhost:8080/states/3

curl -d '[{"op":"add", "from":"/capital", "patch":"8"}]' -H "Content-Type: application/json" -X PATCH http://localhost:8080/states/5

Altera os governadores dos estados:

curl -d '[{"op":"add", "from":"/governor", "patch":"1"}]' -H "Content-Type: application/json" -X PATCH http://localhost:8080/states/1

curl -d '[{"op":"add", "from":"/governor", "patch":"5"}]' -H "Content-Type: application/json" -X PATCH http://localhost:8080/states/2

Remove uma cidade:

curl -H "Content-Type: application/json" -X DELETE http://localhost:8080/cities/5

Exibindo os dados finais:

curl -H "Content-Type: application/json" -X GET http://localhost:8080/states/ -# | python -m json.tool

curl -H "Content-Type: application/json" -X GET http://localhost:8080/cities/ -# | python -m json.tool

curl -H "Content-Type: application/json" -X GET http://localhost:8080/people/ -# | python -m json.tool

Ah... a funcionalidade também permite fazer alguns funções de agregação sobre os valores. Além de, claro, poder ser criados outros mecanismos de transformação e afregação de dados nas funcionalidades futuras.

Exemplo de uso: Saber a população total de um estado somando os valores dos municípios. Basta, na API de cidades, agrupar por estado e somar sobre a coluna population.

curl -H "Content-Type: application/json" -X GET "http://localhost:8080/cities/?c=state_name&c=sum@population" -# | python -m json.tool

Retorno:

[
    {
        "state_name": "DF",
        "stats": {
            "sum_population": 43000
        }
    },
    {
        "state_name": "ES",
        "stats": {
            "sum_population": 76767
        }
    },
    {
        "state_name": "PA",
        "stats": {
            "sum_population": 45621
        }
    },
    {
        "state_name": "PE",
        "stats": {
            "sum_population": 500210
        }
    },
    {
        "state_name": "PR",
        "stats": {
            "sum_population": 50000
        }
    }
]

Os dados são retornados de forma padronizada na propriedade stats. Tal objeto terá tantas propriedades quantas forem as funções de agregação solicitadas utilizando o seguinte padrão FuncaoAgregacao_nomeCampo.

shell curl -H "Content-Type: application/json" -X GET "http://localhost:8080/cities/?c=state_name&c=sum@population&c=avg@population&c=min@population&c=max@population" -# | python -m json.tool Exemplo:

[
    {
        "state_name": "DF",
        "stats": {
            "avg_population": 21500.0,
            "max_population": 40000,
            "min_population": 3000,
            "sum_population": 43000
        }
    },
    {
        "state_name": "ES",
        "stats": {
            "avg_population": 76767.0,
            "max_population": 76767,
            "min_population": 76767,
            "sum_population": 76767
        }
    },
    {
        "state_name": "PA",
        "stats": {
            "avg_population": 45621.0,
            "max_population": 45621,
            "min_population": 45621,
            "sum_population": 45621
        }
    },
    {
        "state_name": "PE",
        "stats": {
            "avg_population": 166736.66666666666,
            "max_population": 500000,
            "min_population": 10,
            "sum_population": 500210
        }
    },
    {
        "state_name": "PR",
        "stats": {
            "avg_population": 50000.0,
            "max_population": 50000,
            "min_population": 50000,
            "sum_population": 50000
        }
    }
]