Skip to main content
Version: 3.1

Service

描述#

Service(也称之为服务)是某类 API 的抽象(也可以理解为一组 Route 的抽象)。它通常与上游服务抽象是一一对应的,但与路由之间,通常是 1:N 即一对多的关系。参看下图。

不同路由规则同时绑定到一个服务上,这些路由将具有相同的上游和插件配置,减少冗余配置。当路由和服务都开启同一个插件时,路由中的插件优先级高于服务中的插件。关于插件优先级的更多信息,请参考 Plugin

更多关于 Service 的信息,请参考 Admin API 的 Service 对象

配置示例#

以下示例创建了一个启用限流插件的服务,并且将该服务绑定到 ID 为 100101 的路由上。

  1. 创建服务。

    curl http://127.0.0.1:9180/apisix/admin/services/200 \
    -H 'X-API-KEY: edd1c9f034335f136f87ad84b625c8f1' -X PUT -d '
    {
    "plugins": {
    "limit-count": {
    "count": 2,
    "time_window": 60,
    "rejected_code": 503,
    "key": "remote_addr"
    }
    },
    "upstream": {
    "type": "roundrobin",
    "nodes": {
    "127.0.0.1:1980": 1
    }
    }
    }'
  2. 创建 ID 为 100 的路由,并绑定 ID 为 200 的服务。

    curl http://127.0.0.1:9180/apisix/admin/routes/100 \
    -H 'X-API-KEY: edd1c9f034335f136f87ad84b625c8f1' -X PUT -d '
    {
    "methods": ["GET"],
    "uri": "/index.html",
    "service_id": "200"
    }'
  3. 创建 ID 为 101 的路由,并绑定 ID 为 200 的服务。

    curl http://127.0.0.1:9180/apisix/admin/routes/101 \
    -H 'X-API-KEY: edd1c9f034335f136f87ad84b625c8f1' -X PUT -d '
    {
    "methods": ["GET"],
    "uri": "/foo/index.html",
    "service_id": "200"
    }'

当然你也可以为路由指定不同的插件配置或上游。比如在以下示例中,我们设置了不同的限流参数,其他部分(比如上游)则继续使用上述服务中的配置参数。

curl http://127.0.0.1:9180/apisix/admin/routes/102 \
-H 'X-API-KEY: edd1c9f034335f136f87ad84b625c8f1' -X PUT -d '
{
"uri": "/bar/index.html",
"id": "102",
"service_id": "200",
"plugins": {
"limit-count": {
"count": 2000,
"time_window": 60,
"rejected_code": 503,
"key": "remote_addr"
}
}
}'
提示

当路由和服务都启用同一个插件时,路由中的插件配置会优先于服务。更多信息,请参考Plugin