Collaborating on an open food data standard and API for the world.
JavaScript Ruby
Permalink
Failed to load latest commit information.
app Bring the site changes from other repo into this one because this is … Mar 8, 2012
config Bring the site changes from other repo into this one because this is … Mar 8, 2012
datasets Created text files that explain which datasets are in use (will be li… Mar 5, 2012
db For some reason heroku is complaining with the migration order so bec… Mar 8, 2012
doc Adding Logo and eps version Mar 7, 2012
lib Ensure that a foodtree uuid property is added to the open food 'food' Mar 8, 2012
public Updating the pre-compiled assets to take in new css styling for Data … Mar 8, 2012
script moving the Rails API app to be the top level of this repository so th… Dec 9, 2011
spec Don't show the food_id in the properties for a food Mar 8, 2012
vendor moving the Rails API app to be the top level of this repository so th… Dec 9, 2011
.gitignore /things endpoint is now /foods Mar 6, 2012
.rvmrc Added db:sync:food_types rake task to import foodtree food types to o… Feb 16, 2012
Gemfile Show a html markup version of the api docs on the website - essential… Mar 8, 2012
Gemfile.lock Show a html markup version of the api docs on the website - essential… Mar 8, 2012
Guardfile moving the Rails API app to be the top level of this repository so th… Dec 9, 2011
README.md Show a html markup version of the api docs on the website - essential… Mar 8, 2012
README.txt Created placeholder README file for API Documentation. Mar 8, 2012
Rakefile Added db:sync:food_types rake task to import foodtree food types to o… Feb 16, 2012
USECASES.txt Added text page for Use Cases Mar 5, 2012
config.ru moving the Rails API app to be the top level of this repository so th… Dec 9, 2011
curls.txt curl a submission with properties Feb 21, 2012

README.md

Open Food Api

Open food documentation

API documentation (Work in progress)

The general idea for the API is that we will create ‘things’ as a way to collect as much properties for a food, ingredient, farm, source, boat, etc.

A relationship can be created by simply adding a property to a ‘farm’ called ‘grows’ with the string value ‘tomato’.  The value of that property is not checked but another lookup can be performed to see information on a ‘tomato’

This was mainly created this way so that we can add ‘foodtree_id’, ‘freebase_id’ properties to items in the database.  We want to be able to associate links to existing sources of information rather than replicate or sync it across.

The primary focus was to gather as much data on an item, easily put it into one place and be able to query it.

http://open-food.heroku.com

Get Foods

HTTP GET to /foods.json

curl http://open-foods.org/foods.json

Example response of 2 foods responded

[{"created_at":"2012-03-08T20:48:26Z","name":"Alcohol","updated_at":"2012-03-08T20:48:26Z","uuid":"0dbaf2b6-6960-11e1-8308-12313933849a","properties":[{"created_at":"2012-03-08T20:48:27Z","name":"Classification: Family","updated_at":"2012-03-08T20:48:27Z","value":"Alcohol"}]},{"created_at":"2012-03-08T20:48:27Z","name":"Garlic","updated_at":"2012-03-08T20:48:27Z","uuid":"0dfeeef8-6960-11e1-8308-12313933849a","properties":[{"created_at":"2012-03-08T20:48:27Z","name":"Classification: Family","updated_at":"2012-03-08T20:48:27Z","value":"allium"}]}]

HTTP GET to /foods.json with name parameter to find a certain food

curl http://open-foods.org/foods.json?name=apple

Example response

[{"created_at":"2012-03-08T20:49:00Z","name":"Custard-apple","updated_at":"2012-03-08T20:49:00Z","uuid":"223aa0a6-6960-11e1-8308-12313933849a","properties":[{"created_at":"2012-03-08T20:49:01Z","name":"Classification: Family","updated_at":"2012-03-08T20:49:01Z","value":"fruit"}]}]

Create a Food with properties

HTTP POST to /foods.json with a 'food' object containing a 'name' attribute with properties.

Example json to post to create a new food:

{“food” :  { “name” : “Apple”, 
  “properties” : [
        {“name” : “color”, “value” : “green”}
        {“name” : “type_of”, “value” : “fruit”}
    ]
}

Adding properties to an existing Food

HTTP POST to /foods/{food_uuid}/properties.json

Example json to post:

{ “properties” : 
[
    {“name” : “color”, “value” : “green”}
    {“name” : “type_of”, “value” : “”}
] 
}

View a Food and it’s properties

HTTP GET to /foods/{food_uuid}.json

Example response with json representation of the food:

{"created_at":"2012-03-08T20:50:21Z","name":"Black Pineapple","updated_at":"2012-03-08T20:50:21Z","uuid":"51f896b8-6960-11e1-8308-12313933849a","properties":[{"created_at":"2012-03-08T20:50:21Z","id":3166,"name":"Scientific name","updated_at":"2012-03-08T20:50:21Z","value":"Solanum lycopersicum"},{"created_at":"2012-03-08T20:50:21Z","id":3165,"name":"Simple Name","updated_at":"2012-03-08T20:50:21Z","value":"Tomato"},{"created_at":"2012-03-08T20:50:21Z","id":3164,"name":"Classification: Family","updated_at":"2012-03-08T20:50:21Z","value":"tomato"}]}

Things to do

  • As a developer be able to query what things have a property with a certain value. For example when I am viewing a ‘tomato’ I would like to see what things there are that have a property set of that.
  • As a developer I would like to see all the different types of property names that can be applied for a thing
  • Consider how duplicate information will be handled
  • How will versions be handled and how will we know who added what data    
  • As a developer I would like to view the information Freebase has on an item I'm viewing. Similar to how the context examples work on simplegeo • Example: If the food item being viewed has a freebase id then link to the page or API for more information

Things to consider later

As open food we want to know who added data (and when)

As a developer I would like to query recipes associated with particular foods

A developer wants to use data about the top counties for production in certain foods (like tomatoes, leafy greens, eggs and pork) to estimate how far these foods travel on average to reach major population centers.

More information

Visit http://open-food.org for more information