0a8edc17c9
This adds the pakage api/rest/client which implements a go-client for the REST API component. It also update the ipfs-cluster-ctl tool to rely on it. Originally, I wanted this to live it in it's own separate repository, but the api client uses /api/types.go, which is part of cluster. Therefore it would need to import all of cluster as a dependency. ipfs-cluster-ctl would also need to import go-ipfs-cluster-api-client as a dependency, creating circular gx deps which would be a mess to maintain. Only the splitting of cluster in multiple repositories (at least for api, rest, ipfs-cluster-ctl, rest/client and test) would allow better dependency management by allowing rest/client and the ctl tool to only import what is needed, but this is something which brings maintenance costs and can probably wait a bit until cluster is more stable. License: MIT Signed-off-by: Hector Sanjuan <code@hector.link>
53 lines
1.9 KiB
Markdown
53 lines
1.9 KiB
Markdown
# ipfs-cluster client
|
|
|
|
|
|
[](https://protocol.ai)
|
|
[](http://github.com/ipfs/ipfs)
|
|
[](http://webchat.freenode.net/?channels=%23ipfs-cluster)
|
|
[](https://github.com/RichardLitt/standard-readme)
|
|
[](https://godoc.org/github.com/ipfs/ipfs-cluster)
|
|
[](https://goreportcard.com/report/github.com/ipfs/ipfs-cluster)
|
|
[](https://travis-ci.org/ipfs/ipfs-cluster)
|
|
[](https://coveralls.io/github/ipfs/ipfs-cluster?branch=master)
|
|
|
|
|
|
> Go client for ipfs-cluster HTTP API.
|
|
|
|
This is a Go client library to use the ipfs-cluster REST HTTP API.
|
|
|
|
|
|
## Table of Contents
|
|
|
|
- [Install](#install)
|
|
- [Usage](#usage)
|
|
- [Contribute](#contribute)
|
|
- [License](#license)
|
|
|
|
## Install
|
|
|
|
You can import `github.com/ipfs/ipfs-cluster/api/rest/client` in your code. If you wish to use [`gx`](https://github.com/whyrusleeping/gx-go) for dependency management, it can be imported with:
|
|
|
|
```
|
|
$ gx import github.com/ipfs/ipfs-cluster/
|
|
```
|
|
|
|
The code can be downloaded and tested with:
|
|
|
|
```
|
|
$ go get -u -d github.com/ipfs/ipfs-cluster
|
|
$ cd $GOPATH/src/github.com/ipfs/ipfs-cluster/rest/api/client
|
|
$ go test -v
|
|
```
|
|
|
|
## Usage
|
|
|
|
Documentation can be read at [Godoc](https://godoc.org/github.com/ipfs/ipfs-cluster/api/rest/client).
|
|
|
|
## Contribute
|
|
|
|
PRs accepted.
|
|
|
|
## License
|
|
|
|
MIT © Protocol Labs
|