Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

docs: add example of Modify (redefine) response only to particular endpoint #37

Open
wants to merge 4 commits into
base: main
Choose a base branch
from
Open

docs: add example of Modify (redefine) response only to particular endpoint #37

Changes from 2 commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
9a2e086
Add example of redefining particular endpoint
pavelsr May 10, 2024
1d26229
[pre-commit.ci] auto fixes from pre-commit.com hooks
pre-commit-ci[bot] May 10, 2024
f372bc4
docs(CHANGELOG): update `CHANGELOG.md`
WSH032 May 11, 2024
c8533aa
Merge remote-tracking branch 'origin/main' into pr/37
WSH032 May 12, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
32 changes: 32 additions & 0 deletions docs/Usage/Advanced.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -118,3 +118,35 @@ async def _(request: Request, path: str = ""):
```

visit `/`, you will notice that the response body is printed to the console.


## Modify (redefine) response only to particular endpoint

```python
from fastapi import FastAPI
from starlette.requests import Request
from fastapi_proxy_lib.core.http import ReverseHttpProxy

app = FastAPI()
Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Perhaps adding lifespan would be better?

app = FastAPI(lifespan=close_proxy_event)

proxy = ReverseHttpProxy(base_url="https://httpbin.org/")
Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Perhaps we should use http here?
Ref: https://wsh032.github.io/fastapi-proxy-lib/Usage/Security/#httpws-vs-httpswss


@app.get("/{path:path}")
async def _(request: Request, path: str = ""):
if path == "ip" and request.method == "GET":
Comment on lines +132 to +135
Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can we add @app.post("/{path:path}") here? Because I see below there's a check for request.method == "GET".

return { "msg": "Method is redefined"}
else:
proxy_response = await proxy.proxy(request=request, path=path)
return proxy_response

if __name__ == "__main__":
import uvicorn
uvicorn.run(app, host="0.0.0.0", port=8000)
```

In this example all requests except `GET /ip` will be passed to `httpbin.org`:

```python
python3 test.py # Uvicorn running on http://0.0.0.0:8000
curl http://127.0.0.0:8000/user-agent # { "user-agent": "curl/7.81.0" }
curl http://127.0.0.0:8000/ip # {"msg":"Method is redefined"}
```
Loading