Skip to main content

Version: 3.11.0

Get APISIX

Apache APISIX is a dynamic, real-time, and high-performance API Gateway. It is a top-level project of the Apache Software Foundation.

You can use APISIX API Gateway as a traffic entrance to process all business data. It offers features including dynamic routing, dynamic upstream, dynamic certificates, A/B testing, canary release, blue-green deployment, limit rate, defense against malicious attacks, metrics, monitoring alarms, service observability, service governance, and more.

In addition, the project also offers APISIX Ingress Controller, an open-source ingress controller that allows you to manage external client traffic to services running in a Kubernetes cluster. The APISIX Ingress Controller routes incoming traffic to specific services based on the requested URL path or hostname.

This tutorial covers two installation methods for you to quickly get started with APISIX:

  • Start APISIX in a Docker container with a quickstart script and configure APISIX using Admin API
  • Start APISIX Ingress Controller on a kind Kubernetes cluster.

Alternatively, you can also use API7 Cloud, a cloud service, to manage APISIX.

Prerequisite(s)​

  • Install Docker to be used in the quickstart script to create containerized etcd and APISIX.
  • Install cURL to be used in the quickstart script and to send requests to APISIX for verification.

Get APISIX​

caution

To provide a better experience in this tutorial, the requirement of Admin API key is switched off by default. Please turn on the API key requirement of Admin API in the production environment.

Start APISIX in Docker with the quickstart script:

curl -sL "https://run.api7.ai/apisix/quickstart" | sh

The script starts two Docker containers, apisix-quickstart and etcd-quickstart in the apisix-quickstart-net Docker network, where etcd is used to store APISIX configurations.

You should see the following message once APISIX is ready:

✔ APISIX is ready!

(Optional) Install API Declarative CLI (ADC)​

You can also install the API Declarative CLI (ADC) to manage APISIX declaratively:

curl -sL "https://run.api7.ai/adc/install" | bash

To verify the installation, run:

adc help

You should see the following response:

Usage: adc [options] [command]

Options:
-V, --version output the version number
-h, --help display help for command

Commands:
ping [options] Verify connectivity with backend
dump [options] Dump configurations from the backend
diff [options] Show the difference between local and backend configurations
sync [options] Sync local configurations to backend
convert [options] Convert other API spec to ADC configurations
lint [options] Check provided configuration files, local execution only, ensuring inputs meet ADC requirements
help [command] display help for command

By default, the backend is set to apisix and the server is set to http://localhost:9180. To verify connectivity with APISIX, run:

adc ping

You should see the following response:

Connected to the "apisix" backend successfully!

See the Command Reference for more details on the available commands.

Verify Installation​

Send a request to see if APISIX is running:

curl -sI "http://127.0.0.1:9080" | grep Server

If everything is ok, you should see the APISIX version:

Server: APISIX/3.11.0

APISIX is now installed and running.

Next Steps​

Please keep the APISIX or APISIX Ingress Controller instance started in this tutorial running to proceed with the following tutorials:

The APISIX instance started with the quickstart script and the APISIX Ingress Controller instance started with kind are not optimized for production. For production installation, please see the production installation options for more information.


API7.ai Logo

API Management for Modern Architectures with Edge, API Gateway, Kubernetes, and Service Mesh.

Product

API7 Cloud

SOC2 Type IIISO 27001HIPAAGDPRRed Herring

Copyright © APISEVEN Ltd. 2019 – 2024. Apache, Apache APISIX, APISIX, and associated open source project names are trademarks of the

Apache Software Foundation