albrtinoaugusto/api-challenge

API RESTful Challenge

developer-challenge

API RESTful Challenge

API feita com java e hospedada no Heroku

#Adicionar país
Metodo: [POST]
https://challenge-rest-api.herokuapp.com/add-country

Exemplo:

{
    "name" : "Brazil",
    "capital" : "Brasília",
    "region" : "America do Sul",
    "subRegion" : "...",
    "area" : "8.516 million km quadrados"
}

Resposta:

{
    "mensagem": "País adicionado com sucesso."
}

#Listar países
Metodo: [GET]
https://challenge-rest-api.herokuapp.com/get-countries

Resposta:

[
    {
        "area": "801 537 km²",
        "capital": "Maputo",
        "subRegion": "...",
        "name": "Mozambique",
        "id": "SomIDGenCounTrY1kEy1886693",
        "region": "Sul"
    },
    {
        "area": "801 800 km²",
        "capital": "Berlim",
        "subRegion": "...",
        "name": "Alemanha",
        "id": "SomIDGenCounTrY3kEy374658",
        "region": "Sudoeste"
    }
]

#Actualizar o país
Metodo: [PUT]
https://challenge-rest-api.herokuapp.com/update-country

Exemplo:

{
        "area": "1000 100 km²",
        "capital": "Kerlim Mil",
        "subRegion": "... Mil",
        "name": "Alemanha",
        "region": "Sudoeste Mil",
        "id":"SomIDGenCounTrY3kEy374658"
}

Nota: não é obrigatorio mandar todos campos, pode amndar somente os que precisa actualizar.

Resposta:

{
    "mensagem": "País actualizado com sucesso."
}

#Eliminar um país
Metodo: [DELETE]
https://challenge-rest-api.herokuapp.com/delete-country

Exemplo:

{
    "id": "SomIDGenCounTrY3kEy374658"
}

Resposta:

{
    "mensagem": "País eliminado com sucesso com sucesso."
}

#Ordenar a lista dos países por qualquer uma das suas propriedades
Metodo: [GET]
https://challenge-rest-api.herokuapp.com/get-countries

É so acrescentar o parametro (order) e o valor respectivo à propriedade pela qual pretende ordenar os paises

Exemplo:
https://challenge-rest-api.herokuapp.com/get-countries?order=region
https://challenge-rest-api.herokuapp.com/get-countries?order=name
ou https://challenge-rest-api.herokuapp.com/get-countries?order=region

Resposta:

[
    {
        "area": "801 537 km²",
        "capital": "Maputo",
        "subRegion": "...",
        "name": "Mozambique",
        "id": "SomIDGenCounTrY1kEy1886693",
        "region": "Sul"
    },
    {
        "area": "801 800 km²",
        "capital": "Berlim",
        "subRegion": "...",
        "name": "Alemanha",
        "id": "SomIDGenCounTrY3kEy374658",
        "region": "Sudoeste"
    }
]