API Playground

I found myself recently needing an example API service against which to demonstrate an API client.

The immediate need was for a set of RESTful GET demo endpoints, but I'll leave room for other protocols.

See the API Documentation page for the details.

Pre-requisites

You'll need Docker installed to build and run this container.

Build the Docker container and run it in live-edit mode with:

docker compose watch

You can then hit the documentation landing page at http://127.0.0.1:8008/.

Note that any edits to the Python code will take effect immediately.

Ctrl+C the running service to stop the container.

With the service running, you can open this link in a browser and see the rendered APIDOC.md file.