Files
mealie/docs/docs/documentation/getting-started/api-usage.md
wengtad 999d0d4322 Optimize Docker (#575)
* reduce docker dev size

* reduce docker prod size

* fix lint

* add gunicorn

* fix bandit reported issues

* add docs external link icon

* add env vars to docs

* add permission to docker

* merge to one backend Dockerfile

* fix codefactor issues

* add docs for puid/pgid

* add docker healthcheck
2021-06-22 10:22:31 -08:00

1.1 KiB

Usage

Getting a Token

Mealie supports long-live api tokens in the user frontend. See user settings page

Key Components

Exploring Your Local API

On your local installation you can access interactive API documentation that provides curl examples and expected results. This allows you to easily test and interact with your API to identify places to include your own functionality. You can visit the documentation at http://mealie.yourdomain.com/docs or see the example at the Demo Site

Recipe Extras

Recipes extras are a key feature of the Mealie API. They allow you to create custom json key/value pairs within a recipe to reference from 3rd part applications. You can use these keys to contain information to trigger automation or custom messages to relay to your desired device.

For example you could add {"message": "Remember to thaw the chicken"} to a recipe and use the webhooks built into mealie to send that message payload to a destination to be processed.

api-extras-gif