Coder Social home page Coder Social logo

api-gateway-cli's Introduction

API GATEWAY CLI

The API Gateway CLI is a vendor agnostic tool that manage, provision any API Gateway platform including Kong, AWS API GW, Akamai and Tyk.

The main motivations behind building this :

  • Support of your API First lifecycle
  • Reduce LockInCost to zero
  • Build your own API Gateway Governance model

apigw

Setup

Supported providers

  • Kong (Ingress)
  • Kong
  • AWS API Gateway
  • Akamai
  • Tyk

Get started (Kong Ingress)

Step.1

Write your OAS spec (example)

Step.2

Define your API Gateway configuration

namespace: mobile
basepath: /
connect_timeout: 10000
read_timeout: 5000
write_timeout: 6000
retries: 3
protocols: 
  - http
  - https
methods:
  - POST
  - GET
host: mobile.api.3stripes.io
upstream_host: test
upstream_port: 8001

** This configuration will change in the next release, as the goal is to build an agnostic configuration **

Step.3

Generate the kong ingress manifests

api-gateway generate --spec="./swagger.yaml" --config="./blueprint-prod.yaml"

Will generate

apiVersion: configuration.konghq.com/v1
kind: KongIngress
metadata:
  name: checkout
  namespace: mobile
proxy:
  path: /
  connect_timeout: 10000
  retries: 3
  read_timeout: 5000
  write_timeout: 6000
route:
  protocols:
    - http
    - https
  methods:
    - POST
    - GET
  strip_path: false
  preserve_host: true
---
apiVersion: extensions/v1beta1
kind: Ingress
metadata:
  name: checkout-ingress
  namespace: mobile
  annotations:
    kubernetes.io/ingress.class: "kong"
spec:
  rules:
  - host: mobile.api.3stripes.io
    http:
      paths:
      - path: /orders/[a-zA-Z0-9_-]+
        backend:
          serviceName: test
          servicePort: 8001

      - path: /
        backend:
          serviceName: test
          servicePort: 8001

      - path: /orders
        backend:
          serviceName: test
          servicePort: 8001

Roadmap

  • Agnostic blueprint configuration
  • Granular endpoints configuration
  • Applications / API Keys provisioning
  • Rate-limit support
  • Authentication/Authz support
  • API Gateway enterprise governance
  • Support AWS API Gateway
  • Support Akamai API Gateway

api-gateway-cli's People

Stargazers

 avatar  avatar

Watchers

 avatar  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.