happyz
/
fastapi
mirror of https://github.com/tiangolo/fastapi.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Add tips on relative url_for in templates docs

This commit is contained in:
Pamela Fox 2023-12-01 10:01:26 -08:00 committed by GitHub
parent 8cf2fa0fe4
commit 4887b9c716
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 11 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
docs/en/docs/advanced/templates.md
View File

@ -72,6 +72,17 @@ In this example, it would link to a CSS file at `static/styles.css` with:
And because you are using `StaticFiles`, that CSS file would be served automatically by your **FastAPI** application at the URL `/static/styles.css`.
!!! note
The url generated by `url_for` is a full absolute URL, including the protocol. That may not work in a reverse proxy situation, like Traefik or GitHub Codespaces.
If you would instead like it to generate relative URLs, you can override the `url_for` template function in your Python code:
```python
templates.env.globals["url_for"] = app.url_path_for
```
Another way to affect the generated URLs is to customize `uvicorn` with arguments like `proxy-headers`, `root-path`, and `forwarded-allow-ips`.
See <a href="https://www.uvicorn.org/settings/#http">uvicorn's docs on settings</a>.
## More details
For more details, including how to test templates, check <a href="https://www.starlette.io/templates/" class="external-link" target="_blank">Starlette's docs on templates</a>.