Skip to content

Dule-martins/api-documentation

 
 

Repository files navigation

Documentation of the Open Food Facts API

The new version of the documentation is available here:

We have an older version available on the Wiki.

Roadmap

We need documentation maintainers

  • to document new features (Eco-Score, Attributes…)

  • to improve existing documents based on feedback and questions in the #api channel

  • What can I help with ? openfoodfacts#23

Edit the documentation

Install the Postman application

https://www.postman.com/downloads/

Clone the repository

git clone https://github.com/openfoodfacts/api-documentation
git checkout -b <DOC_FIX_BRANCH_NAME>

Edit the collection with Postman

  • Open Postman
  • Click "Import" then "Folder" and browse to this repository's folder.
  • Postman collection and environment located in the repo will be imported in your Postman application.
  • Edit the collection using the application, and once you're done click "Export"
  • Rename the file as off-pm-collection.json
  • Save it (overwrite the original one)

Push to git

Now it's time to propose your changes as a pull request on the repository. We're going to make a branch and commit our updated off-pm-collection.json.

Run:

git checkout -b <NEW_BRANCH_NAME>
git add off-pm-collection.json
git commit -m "<COMMIT_MESSAGE>"`
git push --set-upstream origin <NEW_BRANCH_NAME>

Once you are done:

About

Version 2 of the documentation of the V1 API. The code behind the API is at https://github.com/openfoodfacts/openfoodfacts-server

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • HTML 100.0%