apiaxle-proxy
The actual proxy part of ApiAxle.
Last updated 4 years ago by fillup .
Bugs · Original npm · Tarball · package.json
$ cnpm install apiaxle-proxy 
SYNC missed versions from official npm registry.

ApiAxle

Gitter

http://apiaxle.com

A free, locally hosted API management solution. A proxy for your api, statistics for your api & a powerful api of its own.

There are three components which make up the Api Axle system:

The proxy

$ npm install apiaxle-proxy

This is the aspect of the system which does the actual proxying. It sits in front of your API and does the authentication, key checking, queries per day/second checking. This is the bit you want if you want anything. More detail on the main site.

The API

$ npm install apiaxle-api

This is the (optional) API for managing users, keys and endpoints. Once installed, run it with:

$ apiaxle-api

The REPL

$ npm install apiaxle-repl

A way to administer your ApiAxle installation via a command line. Once installed, run it with:

$ apiaxle

You then get a prompt where you can type help to find out more.

The base libs

This is a set of libraries which is required for the above components.


Installation

Check the main site for more detailed installation instructions.

Build

  • master: Build Status
  • develop: Build Status

Docker

Docker image

This repository is auto-built and published as apiaxle/apiaxle.

NOTE: If using this via Docker Compose, use the version 2 syntax for your docker-compose.yml file.

Dockerfiles

This project uses two Dockerfiles, one for production usage named Dockerfile, and a second for development of ApiAxle itself, named Dockerfile-development. Docker Compose is configured to build the development version for you, see below for examples.

Environment Variables

Environment variables can be used to configure NODE_ENV, REDIS_HOST, REDIS_PORT, API_NAME_REGEX and DEBUG_MODE. Below are defaults for production:

  • NODE_ENV = production
  • REDIS_HOST = redis
  • REDIS_PORT = 6379
  • API_NAME_REGEX = ^(.+?)\\.api\\. (extra backslash required for JSON)
  • DEBUG_MODE = false

Start services

docker-compose up -d redis
docker-compose up -d api
docker-compose up -d proxy

Run repl

docker-compose run repl

Run tests

docker-compose run repl test

Enter container

docker-compose run --entrypoint sh repl

Example adding an api and key:

api acme create endPoint='localhost:8000'
key 1234 create
api acme linkkey 1234

Example curl:

curl localhost:3000?api_key=1234 -H 'Host: acme.api.localhost'

Current Tags

  • 1.15.1                                ...           latest (4 years ago)

96 Versions

  • 1.15.1                                ...           4 years ago
  • 1.15.0                                ...           4 years ago
  • 1.14.0                                ...           4 years ago
  • 1.12.35                                ...           5 years ago
  • 1.12.34                                ...           6 years ago
  • 1.12.33                                ...           6 years ago
  • 1.12.32                                ...           6 years ago
  • 1.12.31                                ...           6 years ago
  • 1.12.30                                ...           6 years ago
  • 1.12.29                                ...           6 years ago
  • 1.12.28                                ...           6 years ago
  • 1.12.27                                ...           6 years ago
  • 1.12.26                                ...           6 years ago
  • 1.12.25                                ...           6 years ago
  • 1.12.24                                ...           6 years ago
  • 1.12.23                                ...           6 years ago
  • 1.12.22                                ...           6 years ago
  • 1.12.21                                ...           6 years ago
  • 1.12.20                                ...           6 years ago
  • 1.12.19                                ...           6 years ago
  • 1.12.18                                ...           6 years ago
  • 1.12.17                                ...           6 years ago
  • 1.12.16                                ...           6 years ago
  • 1.12.15                                ...           6 years ago
  • 1.12.13                                ...           6 years ago
  • 1.12.12                                ...           6 years ago
  • 1.12.11                                ...           6 years ago
  • 1.12.10                                ...           6 years ago
  • 1.12.8                                ...           6 years ago
  • 1.12.7                                ...           6 years ago
  • 1.12.6                                ...           6 years ago
  • 1.12.5                                ...           7 years ago
  • 1.12.4                                ...           7 years ago
  • 1.12.3                                ...           7 years ago
  • 1.12.2                                ...           7 years ago
  • 1.12.1                                ...           7 years ago
  • 1.12.0                                ...           7 years ago
  • 1.11.7                                ...           7 years ago
  • 1.11.6                                ...           7 years ago
  • 1.11.5                                ...           7 years ago
  • 1.11.4                                ...           7 years ago
  • 1.11.3                                ...           7 years ago
  • 1.11.2                                ...           7 years ago
  • 1.11.1                                ...           7 years ago
  • 1.11.0                                ...           7 years ago
  • 1.10.3                                ...           7 years ago
  • 1.10.2                                ...           7 years ago
  • 1.10.1                                ...           7 years ago
  • 1.10.0                                ...           7 years ago
  • 1.9.34                                ...           7 years ago
  • 1.9.33                                ...           7 years ago
  • 1.9.32                                ...           7 years ago
  • 1.9.31                                ...           7 years ago
  • 1.9.30                                ...           7 years ago
  • 1.9.29                                ...           7 years ago
  • 1.9.28                                ...           7 years ago
  • 1.9.27                                ...           7 years ago
  • 1.9.26                                ...           7 years ago
  • 1.9.25                                ...           7 years ago
  • 1.9.24                                ...           7 years ago
  • 1.9.23                                ...           7 years ago
  • 1.9.22                                ...           7 years ago
  • 1.9.21                                ...           7 years ago
  • 1.9.20                                ...           7 years ago
  • 1.9.19                                ...           7 years ago
  • 1.9.18                                ...           7 years ago
  • 1.9.17                                ...           7 years ago
  • 1.9.16                                ...           7 years ago
  • 1.9.15                                ...           7 years ago
  • 1.9.14                                ...           7 years ago
  • 1.9.13                                ...           7 years ago
  • 1.9.12                                ...           7 years ago
  • 1.9.11                                ...           7 years ago
  • 1.9.10                                ...           7 years ago
  • 1.9.9                                ...           7 years ago
  • 1.9.8                                ...           7 years ago
  • 1.9.7                                ...           7 years ago
  • 1.9.6                                ...           7 years ago
  • 1.9.5                                ...           7 years ago
  • 1.9.4                                ...           7 years ago
  • 1.9.3                                ...           7 years ago
  • 1.9.2                                ...           7 years ago
  • 1.9.1                                ...           7 years ago
  • 0.9.0                                ...           7 years ago
  • 0.8.5                                ...           7 years ago
  • 0.8.4                                ...           7 years ago
  • 0.8.3                                ...           7 years ago
  • 0.8.2                                ...           7 years ago
  • 0.8.1                                ...           7 years ago
  • 0.8.0                                ...           7 years ago
  • 0.7.1                                ...           7 years ago
  • 0.7.0                                ...           7 years ago
  • 0.6.0                                ...           7 years ago
  • 0.5.0                                ...           7 years ago
  • 0.0.4                                ...           7 years ago
  • 0.0.3                                ...           7 years ago
Maintainers (2)
Downloads
Today 0
This Week 0
This Month 1
Last Day 0
Last Week 0
Last Month 0
Dependencies (9)
Dev Dependencies (2)
Dependents (0)
None

Copyright 2014 - 2016 © taobao.org |