Public/fastapi-cache
1
0
Fork 0
mirror of https://github.com/long2ice/fastapi-cache.git synced 2026-03-25 04:57:54 +00:00
Code Issues Packages Projects Releases Wiki Activity

update README.md

Browse Source
This commit is contained in:
long2ice
2020-11-12 13:04:50 +08:00
parent 0fd9e53e06
commit 3134e5f67c
1 changed files with 7 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
README.md
View File

@@ -74,6 +74,10 @@ async def startup():
``` ```
### Initialization
Firstly you must call `FastAPICache.init` on startup event of `fastapi`, there are some global config you can pass in.
### Use `cache` decorator ### Use `cache` decorator
If you want cache `fastapi` response transparently, you can use `cache` as decorator between router decorator and view function and must pass `request` as param of view function. If you want cache `fastapi` response transparently, you can use `cache` as decorator between router decorator and view function and must pass `request` as param of view function.
@@ -95,6 +99,8 @@ async def index(request: Request, response: Response):
### Custom key builder ### Custom key builder
By default use builtin key builder, if you need, you can override this and pass in `cache` or `FastAPICache.init` to take effect globally.
```python ```python
def my_key_builder( def my_key_builder(
func, func,
@@ -116,7 +122,7 @@ async def index(request: Request, response: Response):
### InMemoryBackend ### InMemoryBackend
`InMemoryBackend` only support in single node instead of distributed environment. `InMemoryBackend` store cache data in memory and use lazy delete, which mean if you don't access it after cached, it will not delete automatically.
## License ## License