Live data from Hacker News

Get information about any country via a RESTful API

restcountries.eu

11–20 of 27 posts

Re: Get information about any country via a RESTful API

#11
post #10

This is nice if considered a programming exercise but it's actually pretty useless for real world use. This data is static, that is it very rarely changes. The whole dataset is also very tiny. It's just better to store this data in-house and don't provide unnecessary point of potential failure by using an external service. An idea on how to make it more useful is to provide downloadable data dump in several formats s…

The project where the data comes from actually offers dumps in three different formats: https://github.com/mledoze/countries

Re: Get information about any country via a RESTful API

#12
post #3

Some of the data seems to be incorrect: http://restcountries.eu/rest/alpha2/za The South African currency is ZAR, not SOS. Cape Town is the legislative capital, but not _the_ capital. If you search by currency for ZAR: http://restcountries.eu/rest/currency/zar You get South Georgia. I assume that's meant to be South Africa.

SOS is the Somali shilling. It seems currencies for Slovakia (No idea what currency XSU is) to South Georgia have shifted one country down.

Re: Get information about any country via a RESTful API

#16

Obligatory warning: API is absolutely not restful.

Since the project seems to have an educational bent, what would the proper REST interface for it look like?

GET:

http://restcountries.eu/rest/alpha/ee would be http://restcountries.eu/countries?alpha=ee

http://restcountries.eu/rest/name/norge would be http://restcountries.eu/countries?name=norge

That seems right, right?

Re: Get information about any country via a RESTful API

#17

Obligatory warning: API is absolutely not restful.

Just wanted to add some thoughts on how one could try to make this RESTful. First, if it were me, I'd pick a media type that can express hyperlinks in JSON (since JSON knows nothing about hyperlinks), maybe something like HAL [1]. Next, I would define my link relations for this API, which in this case would be a collection of countries and the countries themselves (so at least two different types of resources).

After creating the representations of each of these resources, I would then create URI templates in my root response (I guess found at /rest) that allow for the searching aspect that this site is providing, which would be something like:

  { 
    "_links": {
      "search_by_name": {
        "href": "/rest/name/{name}",
        "templated": true
      }
    }
  }
I may build on to this to provide other resources, like a collection of capitals, each with a link to "/rest/capital/{capital_city}", or a resource of currencies, linking to "/rest/currency/{currency}".

The goal of all of this would be to tell the client how to find resources rather than having that hard-coded into the client. These are just some first steps toward being RESTful, and there are lots of different directions you could take this and still be RESTful.

edit: example was incomplete

[1] http://stateless.co/hal_specification.html

Re: Get information about any country via a RESTful API

#18

Obligatory warning: API is absolutely not restful.

Since the project seems to have an educational bent, what would the proper REST interface for it look like? GET: http://restcountries.eu/rest/alpha/ee would be http://restcountries.eu/countries?alpha=ee http://restcountries.eu/rest/name/norge would be http://restcountries.eu/countries?name=norge That seems right, right?

Neither is more or less RESTful than the other. The media type and link relations express to the client what resource is being returned, not the URL itself.

Re: Get information about any country via a RESTful API

#19
post #3

Some of the data seems to be incorrect: http://restcountries.eu/rest/alpha2/za The South African currency is ZAR, not SOS. Cape Town is the legislative capital, but not _the_ capital. If you search by currency for ZAR: http://restcountries.eu/rest/currency/zar You get South Georgia. I assume that's meant to be South Africa.

Same for "calling code". 44 returns Guernsey which is correct but I would expect the UK instead.
Post reply on HN