mirror of https://github.com/hashicorp/consul
40 lines
775 B
Markdown
40 lines
775 B
Markdown
|
Consul API client
|
||
|
|
=================
|
||
|
|
|
||
|
|
This package provides the `api` package which attempts to
|
||
|
|
provide programmatic access to the full Consul API.
|
||
|
|
|
||
|
|
Currently, all of the Consul APIs included in version 0.3 are supported.
|
||
|
|
|
||
|
|
Documentation
|
||
|
|
=============
|
||
|
|
|
||
|
|
The full documentation is available on [Godoc](http://godoc.org/github.com/hashicorp/consul/api)
|
||
|
|
|
||
|
|
Usage
|
||
|
|
=====
|
||
|
|
|
||
|
|
Below is an example of using the Consul client:
|
||
|
|
|
||
|
|
```go
|
||
|
|
// Get a new client, with KV endpoints
|
||
|
|
client, _ := api.NewClient(api.DefaultConfig())
|
||
|
|
kv := client.KV()
|
||
|
|
|
||
|
|
// PUT a new KV pair
|
||
|
|
p := &api.KVPair{Key: "foo", Value: []byte("test")}
|
||
|
|
_, err := kv.Put(p, nil)
|
||
|
|
if err != nil {
|
||
|
|
panic(err)
|
||
|
|
}
|
||
|
|
|
||
|
|
// Lookup the pair
|
||
|
|
pair, _, err := kv.Get("foo", nil)
|
||
|
|
if err != nil {
|
||
|
|
panic(err)
|
||
|
|
}
|
||
|
|
fmt.Printf("KV: %v", pair)
|
||
|
|
|
||
|
|
```
|
||
|
|
|