apisix-admin-rs 0.0.0

Apisix Admin Client
Documentation
apisix-admin-rs-0.0.0 has been yanked.

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:

ENV_VAR DESCRIPTION REQUIRED
HOST_URL The host address of the Smart ID Service Y
RELYING_PARTY_UUID The UUID assigned to the Relying-party - provided by Smart ID Y
RELYING_PARTY_NAME The unique name assigned to the Relying-Party - provided by Smart ID Y
CLIENT_REQ_NETWORK_TIMEOUT_MILLIS The timeout for the REST client when requesting Smart ID Services N - default ()
CLIENT_REQ_MAX_ATTEMPTS The maximum attempts for the REST client retry mechanism
CLIENT_REQ_DELAY_SECONDS_BETWEEN_ATTEMPTS The wait time between consecutive REST client requests
ENABLE_POLLING_BY_LIB Enable automatic polling (when false - polling MUST be implemented by callee

TODO

  • Implement all the Apisix Admin API endpoints
  • Response object mapping to Rust Structs (mostly returned as JSON)