This is a mock API server that can be used to test your applications API calls. While also leveraging the Assertive library to provide declarative assertions to your tests.

The client supports scoped setup/teardown via a context manager:

from assertive_mock_api_client import MockApiClient

client = MockApiClient("http://localhost:8910")

with client.new_scope("team_a") as scoped:
    scoped.when_requested_with(path="/hello").respond_with(
        status_code=200,
        headers={},
        body="scoped response",
    )
    assert scoped.confirm_request(path="/hello")

Notes:

• On enter, the scope is created (POST /__mock__/scopes).
• On exit, the scope is deleted (DELETE /__mock__/scopes/{name}).
• Scoped client calls send the scope as a header key with value "1" by default.
• Nested scopes on the same root client are not supported.

Documentation is built with MkDocs Material and deployed to GitHub Pages via the artifact-based workflow in .github/workflows/docs-pages.yml.

• Feature Backlog

make docs-serve

make docs-build

• Pushes to main trigger docs build + publish.
• Manual reruns are supported via workflow_dispatch.
• Deployment uses actions/upload-pages-artifact and actions/deploy-pages.
• No gh-pages branch and no mkdocs gh-deploy are used.