Skip to main content

​
Endpoint Features

Path

The URL path of the endpoint. For example: /api/v1/products

Method

HTTP method. GET, POST, PUT, DELETE, PATCH, etc.

Operation

The operation performed by the endpoint. For example: “Get product list”

Backend Mapping

The corresponding endpoint in the backend

​
Endpoint Processing Flow

The following diagram shows how the endpoint works in the request and response flow and the path rewriting process:

​
Endpoint Structure

An endpoint contains the following information: 
GET /api/v1/products
│   │   │  │
│   │   │  └─ Resource
│   │   └─ Version
│   └─ Base Path
└─ HTTP Method

​
Example Endpoints

GET /api/v1/products

Get product list

GET /api/v1/products/{id}

Get single product detail

POST /api/v1/products

Create new product

PUT /api/v1/products/{id}

Update product

DELETE /api/v1/products/{id}

Delete product

​
Endpoint and Client Route Relationship

Endpoints are defined under Client Route: 
Client Route: /api/v1/*
│
├─ GET /api/v1/products
├─ GET /api/v1/products/{id}
├─ POST /api/v1/products
├─ PUT /api/v1/products/{id}
└─ DELETE /api/v1/products/{id}
Client Route is the top-level configuration for endpoints. Multiple endpoints can be defined under a Client Route. Endpoints are specific path and method combinations within the Client Route’s path.

​
Endpoint Configuration

When creating an endpoint, the following information is defined:
  • Path: The URL path of the endpoint
  • Method: HTTP method (GET, POST, PUT, DELETE, etc.)
  • Operation ID: Unique identifier of the endpoint
  • Description: Description of the endpoint
  • Query Parameters: Query string parameters in the URL
  • Path Parameters: Dynamic parameters in the URL path (e.g., {id})
  • Header Parameters: HTTP header parameters
  • Request Body: Request body schema (JSON, XML, etc.)
  • Response: Response schema and status codes
  • Content-Type: Request and response content types
  • Backend Path: Corresponding path in the backend
  • Backend Method: HTTP method in the backend
  • Path Rewrite: Path transformation rules

​
Endpoint Types

REST Endpoint

Endpoints for REST APIsData exchange in JSON format. Endpoints compliant with RESTful design principles.

SOAP Endpoint

Endpoints for SOAP Web ServicesData exchange in XML format. Configured with WSDL definitions.

gRPC Endpoint

Endpoints for gRPC servicesData exchange in Protobuf format. High-performance RPC calls.

WebSocket Endpoint

Endpoints for WebSocket connectionsReal-time communication. Provides bidirectional data exchange.

​
Endpoint and Policy Relationship

Endpoint-specific policies can be applied:

Endpoint-Based Security

Different security policies for each endpointSecurity mechanisms such as OAuth2, JWT, API Key can be configured at the endpoint level.

Endpoint-Based Rate Limiting

Different rate limit for each endpointRequest count and bandwidth limits can be defined at the endpoint level.

Endpoint-Based Transformation

Different transformation rules for each endpointJSON ↔ XML conversion, data mapping and transformation can be performed at the endpoint level.

Endpoint-Based Validation

Different validation rules for each endpointRequest/Response validation, schema validation can be configured at the endpoint level.

​
Endpoint Versioning

Endpoints can be versioned:

Version 1

/api/v1/productsFirst version. Basic functionality.

Version 2

/api/v2/productsEnhanced version. New features.

Version 3

/api/v3/productsLatest version. Current API.
Backward compatibility is maintained. Old versions continue to work and new versions do not affect old versions.
Gradual migration can be performed. Clients can migrate to the new version at their own pace.
Different versions can be deployed to different environments and can run simultaneously. Versioning enables API lifecycle management.

​
Endpoint and Routing Relationship

Endpoints serve as a bridge between Client Route and Upstream Target: 
Client Request
   │
   ▼
Client Route (/api/v1/*)
   │
   ▼
Endpoint (GET /api/v1/products)
   │
   │ Routing Logic
   │ (Load Balancing, Failover)
   │
   ▼
Upstream Target (http://backend:8080/products)
   │
   ▼
Backend API
While routing requests from Client Route to Upstream Target, the endpoint applies routing logic and policies.

​
Next Steps

Client Route

Learn about the Client Route concept

Routing and Upstream

Learn about Routing and Upstream concepts

API Proxy Creation

API Proxy creation

Policies

Learn about the Policy concept