Easy to proxy any APIs you want.
Project description
Django Simple API Proxy
This is a simple tool for proxying any APIs easily on your Django server.
You can use it as middleware to make a layer for user authorization or something.
Installation
pip install django-simple-api-proxy
Check it in Pypi.
Quick Start
- Add
django_simple_api_proxy
to yourINSTALLED_APPS
insettings.py
like this:
INSTALLED_APPS = [
...
'django_simple_api_proxy',
]
- Add APP settings to your
settings.py
like this:
TARGET_API_URL = 'https://httpbin.org'
PROXY_ROUTE_PATH = 'my_test_route'
PROXY_TARGET_PATH = 'get'
- Include the
django_simple_api_proxy
URL settings in your projecturls.py
like this:
from django.conf import settings
from django.urls import include
urlpatterns += [
path(settings.PROXY_ROUTE_PATH, include('django_simple_api_proxy.urls'))
]
- Test on your server.
python manage.py runserver
Here's an example you success proxy an API by visit the following URLs.
And the result will be as below.
[06/Sep/2022 01:26:04] "GET /my_test_route/ HTTP/1.1" 200 314
2022-09-06 01:26:06.338 | DEBUG | django_simple_api_proxy.views:get:73 - ----- Proxy GET
2022-09-06 01:26:06.339 | DEBUG | django_simple_api_proxy.views:get_proxy_path:37 - URL: /get
2022-09-06 01:26:06.340 | DEBUG | django_simple_api_proxy.views:update_payload:49 - Username: #anonymous
{
"args": { "username": "#anonymous" },
"headers": {
"Accept": "*/*",
"Accept-Encoding": "gzip, deflate, br",
"Host": "httpbin.org",
"User-Agent": "python-requests/2.27.1",
"X-Amzn-Trace-Id": "Root=1-6316360c-2308560261599de4071127ac"
},
"origin": "xxx.xxx.xxx.xxx",
"url": "https://httpbin.org/get?username=%23anonymous"
}
But when you visit http://127.0.0.1:8000/my_test_route/123
, you'll get error.
Cause this URL is not found on target API server.
So, this proxy server will return this for you.
{ "status": "error" }
Usage
After the quick start, you may want to change some methods with your API server like making an authorization.
You can do it with inheriting the APIProxy
class.
Here is an example:
import requests
from rest_framework.authentication import SessionAuthentication
from rest_framework_simplejwt.authentication import JWTAuthentication
from rest_framework.permissions import IsAuthenticated
from django_simple_api_proxy.views import APIProxy
class MyAPIProxy(APIProxy):
# give custom authentication
authentication_classes = [SessionAuthentication, JWTAuthentication]
# give custom permission
permission_classes = [IsAuthenticated]
def get(self, request, *args, **kwargs):
"""Get."""
# your new `GET` logic here
logger.debug("----- Proxy GET Heyyaya")
response = {"status": "default error!!"}
try:
params = dict(request.GET)
path = self.get_proxy_path(request)
params = self.update_payload(request, params)
middle_resp_ = self.send_request("GET", path, params=params)
response = middle_resp_.json()
except Exception as e:
print('yooooo error occurs!!')
print(e)
return self.response(response)
More
There is an example project you can check in ./example.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
File details
Details for the file django-simple-api-proxy-1.0.2.tar.gz
.
File metadata
- Download URL: django-simple-api-proxy-1.0.2.tar.gz
- Upload date:
- Size: 9.8 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/4.0.2 CPython/3.11.1
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 7c757cf1731f6284f30f132398113faa247b9297b7f9e6ff5e34fcc8b90f9e34 |
|
MD5 | 84e5a387f5e1463d0e71edae25f39306 |
|
BLAKE2b-256 | a5d092552c467bd089ec8ccc4dc779295e3a45c40bb6f677f2e41ca65a048c2d |
File details
Details for the file django_simple_api_proxy-1.0.2-py3-none-any.whl
.
File metadata
- Download URL: django_simple_api_proxy-1.0.2-py3-none-any.whl
- Upload date:
- Size: 7.0 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/4.0.2 CPython/3.11.1
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 2ec9e935c2bc108dfb20d9eef4b713ae688be704725d60d43142dba4d46aa2cf |
|
MD5 | 67e0957813f9eaf2eeb5f9045e6bfdbe |
|
BLAKE2b-256 | 44c24e17ed640e98f6a48e7a3cc10777e0bc09c31e65e603d32754990161d5a0 |