Skip to main content
Version: Next

Expose API

This article will guide you through APISIX's upstream, routing, and service concepts and introduce how to publish your services through APISIX.

Concept introduction#

Upstream#

Upstream is a virtual host abstraction that performs load balancing on a given set of service nodes according to the configured rules.

The role of the Upstream is to load balance the service nodes according to the configuration rules, and Upstream information can be directly configured to the Route or Service.

When multiple routes or services refer to the same upstream, you can create an upstream object and use the upstream ID in the Route or Service to reference the upstream to reduce maintenance pressure.

Route#

Routes match the client's request based on defined rules, load and execute the corresponding plugins, and forwards the request to the specified Upstream.

Service#

A Service is an abstraction of an API (which can also be understood as a set of Route abstractions). It usually corresponds to an upstream service abstraction.

Prerequisites#

Please make sure you have installed Apache APISIX before doing the following.

Expose your service#

  1. Create an Upstream.

Create an Upstream service containing httpbin.org that you can use for testing. This is a return service that will return the parameters we passed in the request.

curl "http://127.0.0.1:9180/apisix/admin/upstreams/1" \
-H "X-API-KEY: edd1c9f034335f136f87ad84b625c8f1" -X PUT -d '
{
"type": "roundrobin",
"nodes": {
"httpbin.org:80": 1
}
}'

In this command, we specify the Admin API Key of Apache APISIX as edd1c9f034335f136f87ad84b625c8f1, use roundrobin as the load balancing mechanism, and set httpbin.org:80 as the upstream service. To bind this upstream to a route, upstream_id needs to be set to 1 here. Here you can specify multiple upstreams under nodes to achieve load balancing.

For more information, please refer to Upstream.

  1. Create a Route.
curl "http://127.0.0.1:9180/apisix/admin/routes/1" \
-H "X-API-KEY: edd1c9f034335f136f87ad84b625c8f1" -X PUT -d '
{
"methods": ["GET"],
"host": "example.com",
"uri": "/anything/*",
"upstream_id": "1"
}'
note

Adding an upstream object to your route can achieve the above effect.

curl "http://127.0.0.1:9180/apisix/admin/routes/1" \
-H "X-API-KEY: edd1c9f034335f136f87ad84b625c8f1" -X PUT -d '
{
"methods": ["GET"],
"host": "example.com",
"uri": "/anything/*",
"upstream": {
"type": "roundrobin",
"nodes": {
"httpbin.org:80": 1
}
}
}'
  1. Test

After creating the Route, you can test the Service with the following command:

curl -i -X GET "http://127.0.0.1:9080/get?foo1=bar1&foo2=bar2" -H "Host: httpbin.org"

APISIX will forward the request to http://httpbin.org:80/anything/foo?arg=10.

More Tutorials#

You can refer to Protect API to protect your API.

You can also use APISIX's Plugin to achieve more functions.