Installing Apache APISIX on Windows

Licio Lentimo
2 min readJan 10, 2022

--

Apache APISIX is a dynamic, real-time, high performance API gateway. It provides rich traffic management such features such as load balancing, dynamic upstream, canary release, circuit breaking, authentication, observability and more.

Apache APISIX

What is an API gateway?

For those that are new to this term, an API gateway is an API management tool that sits between a client and a collection of backend services or microservices. An API gateway acts as a reverse proxy to accept all application programming interface (API) calls, aggregate the various services required to fulfill them, and return the appropriate result.

Prerequisites

So what do you need in order to install Apache APISIX on Windows? You will need to install the following before you proceed:

  • Docker Desktop
  • Windows Subsystem for Linux
  • Git or a command line interface

Docker

Docker is an open-source containerization platform used for developing, deploying, and managing applications in lightweight virtualized environments called containers. It is mainly used as a software development platform for developing distributed applications that work efficiently in different environments. You can download Docker Desktop here.

WSL

The Windows Subsystem for Linux, or WSL, is an optional feature of Windows 10 that allows Linux programs to run natively on Windows. You can download the WSL package for 64-bit machines here.

Git

Git is an Open Source Distributed Version Control System. We need to install Git Bash which is an application for Microsoft Windows environments which provides an emulation layer for a Git command line experience. You can download it here.

Installation

To install Apache APISIX on Windows, head to the the link below.

Open Git Bash and paste the following command to download the Docker image of Apache APISIX:

git clone https://github.com/apache/apisix-docker.git

Next switch to the apisix-docker/example directory

cd apisix-docker/example

Next, Run the docker-compose command to install Apache APISIX

docker-compose -p docker-apisix up -d

This will take some time to install.

Once the download is complete, execute the following command to verify that the install was successful:

curl "http://127.0.0.1:9080/apisix/admin/services/" -H 'X-API-KEY:edd1c9f034335f136f87ad84b625c8f1'

The command should return the following:

{ “count”:1, “action”:”get”, “node”:{ “key”:”/apisix/services”, “nodes”:{}, “dir”:true }}

I have done a tutorial video to show this, you can follow along here.

--

--

Licio Lentimo

I write content on Android and Web technologies. Currently focusing on Cybersecurity. Find me on liciolentimo.com