# python-sdk

**Repository Path**: mirrors_api7/python-sdk

## Basic Information

- **Project Name**: python-sdk
- **Description**: Python SDK for Apache APISIX
- **Primary Language**: Unknown
- **License**: Apache-2.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2020-09-24
- **Last Updated**: 2026-03-21

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# Python SDK for Apache APISIX

More detailed documentation please refer to:
- https://github.com/apache/incubator-apisix/blob/master/doc/admin-api-cn.md

- https://github.com/apache/incubator-apisix/blob/master/doc/architecture-design-cn.md

### Synopsis
```python

from apisix import A6Client

# connect to Apache APISIX admin server
client = A6Client('http://apisix.iresty.com')

# create new upstream
# https://github.com/apache/incubator-apisix/blob/master/doc/architecture-design-cn.md#upstream
upstream_id = 1
ok = client.new_upstream(upstream_id = upstream_id, type = 'roundrobin',
                         nodes = {"127.0.0.1:80": 1, "127.0.0.2:80": 2, "foo.com:80": 0}
                        )

# update upstream info
client.update_upstream(upstream_id = upstream_id,
                        type = 'chash',
                        key = 'remote_addr',
                        nodes = {"127.0.0.1:8000": 1, "foo.com:80": 1},
                        checks = {
                            "active": {
                                "http_path": "/status",
                                "host": "foo.com",
                                "healthy": {
                                    "interval": 2,
                                    "successes": 1
                                },
                                "unhealthy": {
                                    "interval": 1,
                                    "http_failures": 2
                                }
                            }
                        })

# create new route
# https://github.com/apache/incubator-apisix/blob/master/doc/admin-api-cn.md#route
route_id = 1
ok = self.client.new_route(route_id = route_id, uris = ['/test.html'], upstream_id = upstream_id)

# update route to 
client.update_route(route_id = route_id,
                    uris = ['/test.html'],
                    hosts = ['foo.com', '*.bar.com'],
                    plugins = {
                        'limit-count': {
                            'count': 2,
                            'time_window': 60,
                            'rejected_code': 503,
                            'key': 'remote_addr'
                        },
                        'prometheus': {}
                    }
                    )
```

### Prerequisites
You need to install `pip` first.

Then install packages as:
```
cd apache-apisix-python-sdk
make init
```

### Run test cases
```
cd apache-apisix-python-sdk
make clean test
```