Skip to content

docs: when to use FastAPI-CacheX and when another library fits better - #449

Merged
allen0099 merged 1 commit into
masterfrom
claude/charming-gauss-dyvsj7
Oct 8, 2026
Merged

allen0099 merged 1 commit into
masterfrom
claude/charming-gauss-dyvsj7

Conversation

@allen0099

Copy link
Copy Markdown
Owner

Fixes #424

Summary

Adds a comparison page, docs/COMPARISON.md ("When to use it"), with a zh-TW copy. It covers fastapi-cache2, cashews, aiocache, and an HTTP cache or CDN in front of the app. For each one it says what it does well and when it is the better choice:

  • cashews for function caching with early refresh, tags and metrics
  • a CDN for public responses
  • aiocache for a framework-independent cache

It also lists what FastAPI-CacheX does not do.

  • The facts about the other libraries come from the source code of their latest PyPI releases: fastapi-cache2 0.2.2, cashews 7.6.0 and aiocache 0.12.3.
  • Features that are not in a release yet (@cached, coalesce=True, HEAD from GET) are marked 0.4.2 (see Docs: readers on the PyPI release see behaviour from unreleased versions #330).
  • The page is linked from both navs, the README and the zh-TW index.

Checklist

  • The issue above is assigned to me (maintainer's own issue)
  • Tests under tests/ cover the change: docs only, no code changes
  • A changelog fragment: docs only, nothing under fastapi_cachex/
  • uv run pre-commit run --all-files passes, and zensical build --strict passes for both languages

Generated by Claude Code

A comparison page with fastapi-cache2, cashews, aiocache and an HTTP
cache or CDN in front of the app: what each does well and when to pick
it. Facts about the other libraries come from the source of their
latest PyPI release. Features not yet released here are marked 0.4.2.

Closes #424
@allen0099
allen0099 merged commit 0b4cd2d into master Oct 8, 2026
13 checks passed
@allen0099
allen0099 deleted the claude/charming-gauss-dyvsj7 branch October 8, 2026 07:16
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

docs: when to use FastAPI-CacheX and when another library fits better

1 participant