API7 Docs

Key Concepts Overview

Introduction to the core abstractions and entities in API7 Enterprise.

API7 Enterprise uses a structured set of abstractions to manage API traffic, security, and lifecycle. This section introduces these core concepts and explains how they relate to each other in a production environment.

Entity relationships

In API7 Gateway, configurations are managed in the Control Plane and delivered to the Data Plane instances that belong to each gateway group. Services group routes, upstreams, and plugins into a manageable API surface.

The following diagram illustrates the relationship between these core entities:

Contains

Uses

Applies

Owns

Syncs configuration to

Service

Routes

Upstream

Plugins

Gateway Group

Data Plane Nodes

Contains

Uses

Applies

Owns

Syncs configuration to

Service

Routes

Upstream

Plugins

Gateway Group

Data Plane Nodes

Core abstractions

The table below summarizes the fundamental concepts in API7 Gateway.

ConceptDescription
Services and RoutesGrouping of URI-based matching rules (Routes) sharing common backend and plugin configurations (Services).
Upstreams and Load BalancingDefinitions of backend targets, including load balancing algorithms and health checks.
Consumers and CredentialsIdentity representing an API caller and their associated authentication tokens.
PluginsModular components that intercept and modify the request/response flow for security, traffic control, and observability.
SSL CertificatesTLS assets used to terminate HTTPS traffic and secure client or upstream connections.
Gateway GroupsLogical deployment targets that isolate configuration across environments, regions, or teams.
Service DiscoveryDynamic upstream endpoint discovery through systems such as Kubernetes, Consul, and Nacos.
Stream RoutesRouting rules for TCP and UDP traffic handled by the gateway's stream proxy.

Next steps

Deep dive into each concept to understand how to design and manage your API infrastructure: