OpenAPI Specification

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

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

Use the provided swagger compose file in the repository:

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

Then browse to: http://localhost:8001