api-documentation
api-documentation copied to clipboard
Version 2 of the documentation of the V1 API. The code behind the API is at https://github.com/openfoodfacts/openfoodfacts-server. An effort is made there to create a V3 of the documentation based on...
API Documentation
Deprecation notice
Important: This documentation is being deprecated in favour of the new OpenAPI documentation (see below)
Up-to-date Documentation of the Open Food Facts API
- intro: https://openfoodfacts.github.io/openfoodfacts-server/introduction/api/
- reference: https://openfoodfacts.github.io/openfoodfacts-server/reference/api/
- The source: https://github.com/openfoodfacts/openfoodfacts-server/tree/main/docs/reference
Rendering of this (deprecated) documentation
The API documentation is rendered here (see above for the more up-to-date documentation):
- Stable version of the doc: https://openfoodfacts.github.io/api-documentation/
- Staging version of the doc: https://openfoodfacts.github.io/api-documentation-staging/
We have an older version available on the Wiki.
- https://wiki.openfoodfacts.org/Documentation
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 ? https://github.com/openfoodfacts/api-documentation/issues/23
Edit this (deprecated) documentation
Remember that this project is deprecated, you should instead contribute to the OpenAPI 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:
- Open a browser
- Navigate to https://github.com/openfoodfacts/api-documentation
- Open a new PR from your branch ("Create Pull Request" button).
- View your updated documentation that was automatically deployed to the staging environment https://openfoodfacts.github.io/api-documentation-staging.
Applications using this API
Official application
The official Open Food Facts app uses the API.
Third party applications
Feel free to open a PR to add your application in this list.