summaryrefslogtreecommitdiff
path: root/docs/reference.md
blob: f5a1b8a7792f2d8ef1583be7d21d67b2c0ec9a22 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
% Note: The module sources referenced here are auto-generated with apidoc
(reference)=
# {fa}`list` API Reference
This section covers all the public interfaces of requests-cache.

:::{tip}
It's recommended to import from the top-level `requests_cache` package, as internal module paths
may be subject to change. For example:
```python
from requests_cache import CachedSession, RedisCache, json_serializer
```
:::

```{toctree}
:maxdepth: 1
session
modules/requests_cache.patcher
```
```{toctree}
:maxdepth: 2
modules/requests_cache.backends
modules/requests_cache.models
modules/requests_cache.serializers
```
```{toctree}
:maxdepth: 1
modules/requests_cache.cache_keys
modules/requests_cache.cache_control
```