cascade/ipfs-cluster
5
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
6164ad35b8
ipfs-cluster/api/rest/client/README.md

44 lines
1.4 KiB
Markdown
Raw Normal View History

Fix #260: Add REST API client and use it in ipfs-cluster-ctl 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>
2017-12-05 20:44:22 +00:00
# ipfs-cluster client
README: more improvements to badges
2022-06-15 13:11:38 +00:00
[![Made by](https://img.shields.io/badge/By-Protocol%20Labs-000000.svg?style=flat-square)](https://protocol.ai)
[![Main project](https://img.shields.io/badge/project-ipfs--cluster-ef5c43.svg?style=flat-square)](http://github.com/ipfs-cluster)
[![Discord](https://img.shields.io/badge/forum-discuss.ipfs.io-f9a035.svg?style=flat-square)](https://discuss.ipfs.io/c/help/help-ipfs-cluster/24)
[![Matrix channel](https://img.shields.io/badge/matrix-%23ipfs--cluster-3c8da0.svg?style=flat-square)](https://app.element.io/#/room/#ipfs-cluster:ipfs.io)
Migrate from ipfs/ipfs-cluster to ipfs-cluster/ipfs-cluster This performs the necessary renamings.
2022-06-15 09:19:17 +00:00
[![pkg.go.dev](https://pkg.go.dev/badge/github.com/ipfs-cluster/ipfs-cluster)](https://pkg.go.dev/github.com/ipfs-cluster/ipfs-cluster/api/rest/client)
Fix #260: Add REST API client and use it in ipfs-cluster-ctl 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>
2017-12-05 20:44:22 +00:00
Migrate from ipfs/ipfs-cluster to ipfs-cluster/ipfs-cluster This performs the necessary renamings.
2022-06-15 09:19:17 +00:00
> Go client for the ipfs-cluster HTTP API.
Fix #260: Add REST API client and use it in ipfs-cluster-ctl 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>
2017-12-05 20:44:22 +00:00
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
Migrate from ipfs/ipfs-cluster to ipfs-cluster/ipfs-cluster This performs the necessary renamings.
2022-06-15 09:19:17 +00:00
You can import `github.com/ipfs-cluster/ipfs-cluster/api/rest/client` in your code.
Fix #260: Add REST API client and use it in ipfs-cluster-ctl 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>
2017-12-05 20:44:22 +00:00
The code can be downloaded and tested with:
```
Migrate from ipfs/ipfs-cluster to ipfs-cluster/ipfs-cluster This performs the necessary renamings.
2022-06-15 09:19:17 +00:00
$ git clone https://github.com/ipfs-cluster/ipfs-cluster.git
$ cd ipfs-cluster/ipfs-cluster/rest/api/client
Fix #260: Add REST API client and use it in ipfs-cluster-ctl 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>
2017-12-05 20:44:22 +00:00
$ go test -v
```
## Usage
Migrate from ipfs/ipfs-cluster to ipfs-cluster/ipfs-cluster This performs the necessary renamings.
2022-06-15 09:19:17 +00:00
Documentation can be read at [pkg.go.dev](https://pkg.go.dev/github.com/ipfs-cluster/ipfs-cluster/api/rest/client).
Fix #260: Add REST API client and use it in ipfs-cluster-ctl 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>
2017-12-05 20:44:22 +00:00
## Contribute
PRs accepted.
## License
MIT © Protocol Labs
Reference in New Issue Copy Permalink