Apache APISIX · JSON Structure

Service Structure

A Service is an abstraction of an API and corresponds to an upstream service. It can be shared across routes.

Type: object Properties: 8
ApacheAPI GatewayCloud NativeKubernetesLuaNGINXOpen SourceTraffic Management

Apache APISIX Service is a JSON Structure definition published by Apache APISIX, describing 8 properties. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

name desc plugins upstream upstream_id labels enable_websocket hosts

Meta-schema: https://json-structure.org/meta/core/v0/#

JSON Structure

Raw ↑ 
{
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/apache-apisix/refs/heads/main/json-structure/service-structure.json",
  "name": "Apache APISIX Service",
  "description": "A Service is an abstraction of an API and corresponds to an upstream service. It can be shared across routes.",
  "type": "object",
  "properties": {
    "name": {
      "type": "string",
      "description": "Human-readable name for the service."
    },
    "desc": {
      "type": "string",
      "description": "Description of the service."
    },
    "plugins": {
      "type": "object",
      "description": "Plugin configuration. Key is the plugin name and value is the plugin config."
    },
    "upstream": {
      "$ref": "upstream.json",
      "description": "Inline upstream configuration."
    },
    "upstream_id": {
      "type": "string",
      "description": "ID of an existing upstream to use."
    },
    "labels": {
      "type": "object",
      "additionalProperties": {
        "type": "string"
      },
      "description": "Key-value pairs for categorization."
    },
    "enable_websocket": {
      "type": "boolean",
      "description": "Enable WebSocket proxying."
    },
    "hosts": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "A list of hosts for the service."
    }
  }
}