Code Monkey home page Code Monkey logo

djangoapigateway's Introduction

Django API gateway

Description

This is a simple apigateway for django to transmit restful api.

Requirements

  • Python(2.7)
  • Django(1.8)
  • requests
  • djangorestframework

Installation

Install using pip

pip install django-api-gateway

Add 'apigateway' and 'rest_framework' to your INSTALLED_APPS setting.

    INSTALL_APPS = (
        ...
        'apigateway',
        'rest_framework',
    )

Add the following to your root urls.py file.

urlpatterns = [
    ...
    url(r'^service/', include('apigateway.urls', namespace='apigateway')),
]

Update database model

python manage.py migrate
python manage.py makemigrations

example

visit http://yourhost/admin/apigateway/api/ to add/edit/delete your restful apis

eg: if you add api like this:

name         | construct              
request_path | /construct/                
upstream_url | http://constructhost/              
plugin       | Remote auth             
consumers    | null            

now when you visit http://yourhost/service/construct/... it will transfer to http://constructhost/...

Note

  • api name must be unique

  • plugin contain 3 types

    • Remote auth - apigateway not check auth, it will transfer the auth to the real server
    • Basic auth - you must get basic auth from apigateway
    • Key auth - you must get an apikey from apigateway
  • when choose Key auth you should contain {'apikey': apikey} in headers
    curl -i -X GET --url http://yourhost/service/... --header 'apikey: apikey'

djangoapigateway's People

Contributors

sarar04 avatar flyhigher139 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.