starlette/docs/staticfiles.md

26 lines
719 B
Markdown

Starlette also includes a `StaticFiles` class for serving files in a given directory:
### StaticFiles
Signature: `StaticFiles(directory, check_dir=True)`
* `directory` - A string denoting the directory path
* `check_dir` - Ensure that the directory exists upon instantiation. Defaults to `True`
You can combine this ASGI application with Starlette's routing to provide
comprehensive static file serving.
```python
from starlette.routing import Router, Mount
from starlette.staticfiles import StaticFiles
app = Router(routes=[
Mount('/static', app=StaticFiles(directory='static')),
])
```
Static files will respond with "404 Not found" or "405 Method not allowed"
responses for requests which do not match.