open-consul/api/README.md

44 lines
823 B
Markdown
Raw Normal View History

Consul API client
=================
This package provides the `api` package which attempts to
provide programmatic access to the full Consul API.
2015-11-29 04:04:29 +00:00
Currently, all of the Consul APIs included in version 0.6.0 are supported.
Documentation
=============
2016-01-13 22:44:01 +00:00
The full documentation is available on [Godoc](https://godoc.org/github.com/hashicorp/consul/api)
Usage
=====
Below is an example of using the Consul client:
```go
2015-10-23 19:20:01 +00:00
// Get a new client
client, err := api.NewClient(api.DefaultConfig())
if err != nil {
panic(err)
}
// Get a handle to the KV API
kv := client.KV()
// PUT a new KV pair
p := &api.KVPair{Key: "foo", Value: []byte("test")}
2015-10-23 19:20:01 +00:00
_, 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)
```