Skip to content

Commit 5aa8f65

Browse files
committed
[update] readme
1 parent 347ee05 commit 5aa8f65

File tree

1 file changed

+9
-1
lines changed

1 file changed

+9
-1
lines changed

README.md

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
# Django Simple API Proxy
22

3+
[![Test](https://github.com/NatLee/Django-Simple-API-Proxy/actions/workflows/test.yml/badge.svg)](https://github.com/NatLee/Django-Simple-API-Proxy/actions/workflows/test.yml)[![Release](https://github.com/NatLee/Django-Simple-API-Proxy/actions/workflows/release.yml/badge.svg)](https://github.com/NatLee/Django-Simple-API-Proxy/actions/workflows/release.yml)
4+
35
This is a simple tool for proxying any APIs easily on your Django server.
46

57
You can use it as middleware to make a layer for user authorization or something.
@@ -10,6 +12,8 @@ You can use it as middleware to make a layer for user authorization or something
1012
pip install django-simple-api-proxy
1113
```
1214

15+
Check it in [Pypi](https://pypi.org/project/django-simple-api-proxy/).
16+
1317
## Quick Start
1418

1519
1. Add `django_simple_api_proxy` to your `INSTALLED_APPS` in `settings.py` like this:
@@ -26,7 +30,7 @@ INSTALLED_APPS = [
2630
```py
2731
TARGET_API_URL = 'https://httpbin.org'
2832
PROXY_ROUTE_PATH = 'my_test_route'
29-
PROXY_TARGET_PATH = ''
33+
PROXY_TARGET_PATH = 'get'
3034
```
3135

3236
3. Include the `django_simple_api_proxy` URL settings in your project `urls.py` like this:
@@ -127,3 +131,7 @@ class MyAPIProxy(APIProxy):
127131
return self.response(response)
128132

129133
```
134+
135+
## More
136+
137+
There is an example project you can check in [./example](https://github.com/NatLee/Django-Simple-API-Proxy/tree/main/example/api_proxy_example).

0 commit comments

Comments
 (0)