Skip to content
Apprise Apprise Apprise Documentation

OpenAPI Specification

Apprise API includes an OpenAPI 3 specification in swagger.yaml at the root of the repository here

Running Swagger UI

Section titled “Running Swagger UI”

For local development or API exploration, you can bring up a standalone Swagger UI that reads the specification file without changing how the main Apprise API runs.

Via Docker Compose

Section titled “Via Docker Compose”

Use the provided swagger compose file in the repository:

Terminal window
docker compose -f docker-compose.swagger.yml up -d

Then browse to: http://localhost:8001

Questions or Feedback?

Documentation

Notice a typo or an error? Report it or contribute a fix .

Technical Issues

Having trouble with the code? Open an issue on GitHub:

Made with love from Canada