Docs

Table of Contents

API

The Vegan-Inspector API is written in PHP using the Slim framework and is open source. Full API documentation is available as a Swagger UI, and the raw openapi.yaml spec is served alongside it.

The base URL for all API requests is:

https://api.vegan-inspector.app/v0/

Swagger UI openapi.yaml

Self-hosting

You can run the API yourself using Docker:

docker run -p 8080:8080 codeberg.org/vegan-inspector/api:latest

The source code and setup instructions for local development are available on Codeberg:

Source Code

Data Sources

We currently retrieve data from the following sources — more are planned:

  • OpenFoodFacts : a free, open, and crowdsourced database of food products from around the world.

Issues & Contributions

Found a bug or have a suggestion? Feel free to open an issue on Codeberg.

Open an Issue