Service

Service 是某类 API 的抽象（也可以理解为一组 Route 的抽象）。它通常与上游服务抽象是一一对应的，Route 与 Service 之间，通常是 N:1 的关系，参看下图。

服务示例

不同 Route 规则同时绑定到一个 Service 上，这些 Route 将具有相同的上游和插件配置，减少冗余配置。

比如下面的例子，创建了一个启用限流插件的 Service，然后把 id 为 100、101 的 Route 都绑定在这个 Service 上。

  1. # create new Service
  2. $ curl http://127.0.0.1:9080/apisix/admin/services/200 -H 'X-API-KEY: edd1c9f034335f136f87ad84b625c8f1' -X PUT -d '
  3. {
  4.     "plugins": {
  5.         "limit-count": {
  6.             "count": 2,
  7.             "time_window": 60,
  8.             "rejected_code": 503,
  9.             "key": "remote_addr"
  10.         }
  11.     },
  12.     "upstream": {
  13.         "type": "roundrobin",
  14.         "nodes": {
  15.             "127.0.0.1:1980": 1
  16.         }
  17.     }
  18. }'
  20. # create new Route and reference the service by id `200`
  21. curl http://127.0.0.1:9080/apisix/admin/routes/100 -H 'X-API-KEY: edd1c9f034335f136f87ad84b625c8f1' -X PUT -d '
  22. {
  23.     "methods": ["GET"],
  24.     "uri": "/index.html",
  25.     "service_id": "200"
  26. }'
  28. curl http://127.0.0.1:9080/apisix/admin/routes/101 -H 'X-API-KEY: edd1c9f034335f136f87ad84b625c8f1' -X PUT -d '
  29. {
  30.     "methods": ["GET"],
  31.     "uri": "/foo/index.html",
  32.     "service_id": "200"
  33. }'

当然我们也可以为 Route 指定不同的插件参数或上游，比如下面这个 Route 设置了不同的限流参数，其他部分（比如上游）则继续使用 Service 中的配置参数。

  1. curl http://127.0.0.1:9080/apisix/admin/routes/102 -H 'X-API-KEY: edd1c9f034335f136f87ad84b625c8f1' -X PUT -d '
  2. {
  3.     "uri": "/bar/index.html",
  4.     "id": "102",
  5.     "service_id": "200",
  6.     "plugins": {
  7.         "limit-count": {
  8.             "count": 2000,
  9.             "time_window": 60,
  10.             "rejected_code": 503,
  11.             "key": "remote_addr"
  12.         }
  13.     }
  14. }'

注意：当 Route 和 Service 都开启同一个插件时，Route 中的插件参数会优先于 Service 被使用。