Apisix admin Rust client

⚡ Maintained by ⚡

A straightforward Apisix admin client library.

Introduction

This library implements the Apisix Admin interface Reference API.

Apisix API Version: 3.10

Status

Under development!

Documentation

Apisix Getting Started

Apisix Local Dev

The script starts two Docker containers, apisix-quickstart and etcd. APISIX uses etcd to save and synchronize configurations. Both the etcd and the APISIX use host Docker network mode. That is, the APISIX can be accessed from local.

curl -sL https://run.api7.ai/apisix/quickstart | sh

Build

cargo build

Tests

cargo test

Documentation

cargo doc --no-deps --open

Example Client

See the examples folder for a simple example client. To create an SmartID account, download the app:

The example application goes through the following use cases:

• Verify Certificate Existence
• SmartID Authentication
• SmartID Digital Signature

The example is using a MOCK ID to simulate the SmartID user.

cargo run --example smart_id_client

Configuration

Default values are provided and targets the TEST environment of Smart ID. The required environment variables used:

Plugins implemented

• consumer-restriction
• apikey
• limit-count
• proxy-rewrite
• authz-keycloak
• redirect
• openid-connect
• cors
• serverless
• forward-auth

TODO

This library started with basic CRUD operations for Apisix resources mostly used in projects. Is does not (yet) implement the full API, but feel free to contribute.

• Implement the control API endpoints
• Response object mapping to Rust Structs (mostly returned as JSON value)
• Upstream: Update Upstream builder: add pass_host, upstream_host, health_check, hash_on key, labels, tls, keepalive
• Upstream: patch use cases
• Service: patch use cases
• Route: patch use cases
• Missing Plugins (only adding plugins used, but feel free to extend))
• Long list of plugins to implement

Remarks

Read the conventions upon ID Syntax:

ID Syntax

This library assumes that all Apisix resources are created with a unique ID. The ID is a string that is unique within the scope of the resource type. The ID is used to identify the resource in the Apisix Admin API. The ID must be a string literal, integer literals are not supported yet (both are possible in Apisix).

Examples

Run the examples: In case you need debug logs:

RUST_LOG=info,apisix_admin=debug,apisix_plugins=debug cargo run --example apisix-admin

Admin Resources examples:

cargo run --example apisix-admin

Plugin examples:

cargo run --example apisix-plugins